Ruby - Revision history

Iwiseman: /* Resources */

2020-08-13T03:41:06Z

Resources

← Older revision		Revision as of 03:41, 13 August 2020
Line 1,046:		Line 1,046:
	==Resources==		==Resources==
	* [[rubydoc.info]]		* [[rubydoc.info]]
	* rubygems.org		* [[rubygems.org]]
	* ruby-lang.org		* [[ruby-lang.org]]
	* ruby-toolbox.com		* [[ruby-toolbox.com]]
	* rspec.info		* [[rspec.info]]
	* cukes.info		* [[cukes.info]]

Iwiseman: /* Resources */

2020-08-13T03:40:42Z

Resources

← Older revision		Revision as of 03:40, 13 August 2020
Line 1,045:		Line 1,045:
	* Run gem list		* Run gem list
	==Resources==		==Resources==
	* rubydoc.info		* [[rubydoc.info]]
	* rubygems.org		* rubygems.org
	* ruby-lang.org		* ruby-lang.org

Iwiseman: /* Organizing Code */

2020-08-13T03:40:12Z

Organizing Code

← Older revision		Revision as of 03:40, 13 August 2020
Line 1,008:		Line 1,008:

	require_relative 'deep_space/spaceship'		require_relative 'deep_space/spaceship'

	require 'json'		require 'json'

	You can look at the load path using $LOAD_PATH		You can look at the load path using $LOAD_PATH

	==Gems==		==Gems==
	===Introduction===		===Introduction===

Iwiseman: /* General */

2020-08-13T03:39:51Z

General

← Older revision		Revision as of 03:39, 13 August 2020
Line 1,004:		Line 1,004:
	- test		- test
	- init.rb		- init.rb
			To include a file use __dir__ (current path)
			require '#{__dir__}/deep_space/spaceship'

			require_relative 'deep_space/spaceship'

			require 'json'

			You can look at the load path using $LOAD_PATH
			==Gems==
			===Introduction===
			Gems are the equivalent of nuget packages.
			===Sites===
			The main site is [[http://rubygems.org]] or [[https://www.ruby-toolbox.com]]
			===Usage===
			Here is some examples
			gem install log4r
			gem list
			===Bundler===
			This allows you to provide a list of dependency for your app. You put these in a Gemfile.
			source 'https://rubygems.org'

			gem 'pg', '0.13.2'
			gem 'haml', '3.1.6'
			To install you can then do
			bundle install
			==Testing==
			=== Test Driven Development (TDD)===
			An example for this is mini test
			=== Behaviour Driven Development (BDD)===
			An example for this is cucumber
			==Packaging==
			===Type of packaging===
			* Source control + bundler
			* Package as a gem
			===Gem Example===
			* Create a gemspec file
			* Run gem build <gemspec file>
			* Run gem install <package>
			* Run gem list
			==Resources==
			* rubydoc.info
			* rubygems.org
			* ruby-lang.org
			* ruby-toolbox.com
			* rspec.info
			* cukes.info

Iwiseman: /* Methods */

2020-08-13T03:06:17Z

Methods

← Older revision		Revision as of 03:06, 13 August 2020
Line 990:		Line 990:
	>Exit code: 0		>Exit code: 0
	You are also responsible for maintaining the method_missing signature. It's possible to write a hook that captures only a missing method's name while ignoring its arguments and associated block.		You are also responsible for maintaining the method_missing signature. It's possible to write a hook that captures only a missing method's name while ignoring its arguments and associated block.

			=General=
			==Organizing Code==
			Here is a typical example
			product_deep_space
			- bin
			- doc
			- lib
			- deep_space
			- spaceship.rb
			- probe.rb
			- deep_space.rb
			- test
			- init.rb

Iwiseman: /* Blocks */

2020-08-13T03:01:55Z

Blocks

← Older revision		Revision as of 03:01, 13 August 2020
Line 366:		Line 366:

	=Blocks, Procs and Lambdas=		=Blocks, Procs and Lambdas=
	=Blocks=		==Blocks==
	==Introduction==		===Introduction===
	Blocks are either single lines of code inside curly braces		Blocks are either single lines of code inside curly braces
	<syntaxhighlight lang="ruby">		<syntaxhighlight lang="ruby">
Line 380:		Line 380:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
	==Example==		===Example===
	When you pass a block the result is evaluated at the yield		When you pass a block the result is evaluated at the yield
	<syntaxhighlight lang="ruby">		<syntaxhighlight lang="ruby">
Line 399:		Line 399:
	</syntaxhighlight>		</syntaxhighlight>

	==Block arguments==		===Block arguments===
	Here is an example of a do..end block		Here is an example of a do..end block
	<syntaxhighlight lang="ruby">		<syntaxhighlight lang="ruby">
Line 425:		Line 425:
	#>Custom components: {:seats=>:leather}		#>Custom components: {:seats=>:leather}
	</syntaxhighlight>		</syntaxhighlight>
	==Block Context==		===Block Context===
	When you invoke a block the context which it was invoked in is present. That is to say the available parameters are still available in the yield.		When you invoke a block the context which it was invoked in is present. That is to say the available parameters are still available in the yield.
	<syntaxhighlight lang="ruby">		<syntaxhighlight lang="ruby">
Line 448:		Line 448:
	ship1.launch		ship1.launch
	</syntaxhighlight>		</syntaxhighlight>
	==Example Usage==		===Example Usage===
	Here is an example usage of block where timings are acquired and perhaps makes more sense for the approach		Here is an example usage of block where timings are acquired and perhaps makes more sense for the approach
	<syntaxhighlight lang="ruby">		<syntaxhighlight lang="ruby">

Iwiseman: /* Classes */

2020-08-13T02:59:10Z

Classes

← Older revision		Revision as of 02:59, 13 August 2020
Line 746:		Line 746:

	puts spaceShip.insane		puts spaceShip.insane
			</syntaxhighlight>

			=Modules=
			==Namespaces==
			This is used to create namespaces for methods and classes and can be nested
			<syntaxhighlight lang="ruby">
			module API
			def self.hatch_list
			# blah
			end
			end

			hatches = API.hatch_list

			module Spacestuff
			class Spaceship
			end
			end

			ship = SpaceStuff::Spaceship.new

			module A
			module B
			class Test
			end
			end
			end

			testy = A::B::Test.new
			</syntaxhighlight>
			==Mixins==
			==Instance Mixins==
			This is a way of combining functionality into different classes. Define a module and then include it in your class.
			<syntaxhighlight lang="ruby">
			module AirControl
			def measure_oxygen
			# blah
			end
			end

			class Spaceship
			include AirControl
			# blah
			end

			ship = Spaceship.new
			ship.measure_oxygen
			</syntaxhighlight>
			==Class Method (static method) Mixins==
			Using extend can be used to mixin class methods
			<syntaxhighlight lang="ruby">
			class Spaceship
			extend AirControl
			# blah
			end

			Spaceship.measure_oxygen
			</syntaxhighlight>

			==Including Static and Non Static Mixins==
			You can provide the hook method included in your module to reduce the need to include and extend.
			<syntaxhighlight lang="ruby">
			module Docking
			module ClassMethods
			def get_default_config
			#
			end
			end

			def self.included(base)
			base.extend(ClassMethods)
			end

			def dock
			end
			end

			class Spaceship
			include Docking
			end
	</syntaxhighlight>		</syntaxhighlight>

Iwiseman: /* Lamdas */

2020-08-13T02:25:58Z

Lamdas

← Older revision		Revision as of 02:25, 13 August 2020
Line 484:		Line 484:
	</syntaxhighlight>		</syntaxhighlight>
	==Lamdas==		==Lamdas==
	Lambda can also be created from blocks.		Lambda can also be created from blocks. You must pass the right number of arguments to a lamba
	<syntaxhighlight lang="ruby">		<syntaxhighlight lang="ruby">
	lmb = lambda {\|bla\| "I am a proc that says #{bla}!" }		lmb = lambda {\|bla\| "I am a proc that says #{bla}!" }

Iwiseman: /* Lamdas */

2020-08-13T02:23:32Z

Lamdas

← Older revision		Revision as of 02:23, 13 August 2020
Line 484:		Line 484:
	</syntaxhighlight>		</syntaxhighlight>
	==Lamdas==		==Lamdas==
			Lambda can also be created from blocks.
			<syntaxhighlight lang="ruby">
			lmb = lambda {\|bla\| "I am a proc that says #{bla}!" }

			# Stabby Lambdas
			also_lmb = ->(bla) {"I am a proc that says #{bla}!" }
			</syntaxhighlight>

	=Exceptions=		=Exceptions=

Iwiseman: /* Blocks, Procs and Lambdas */

2020-08-13T02:19:02Z

Blocks, Procs and Lambdas

← Older revision		Revision as of 02:19, 13 August 2020
Line 366:		Line 366:

	=Blocks, Procs and Lambdas=		=Blocks, Procs and Lambdas=
			=Blocks=
			==Introduction==
			Blocks are either single lines of code inside curly braces
			<syntaxhighlight lang="ruby">
			ships = Spaceship.all
			ships.each{ \|ship\| put ship.name}
			end
			</syntaxhighlight>
			Or multi-line inside a do
			<syntaxhighlight lang="ruby">
			[1,2,3].each do
			puts "This is a loop"
			end
			</syntaxhighlight>
			==Example==
			When you pass a block the result is evaluated at the yield
			<syntaxhighlight lang="ruby">
			class Spaceship
			def debug_only
			return nil unless @debug
			return nil unless block_given
			puts "Running debug code..."
			yield
			end
			end

			ship.debug_only # No output because block not given

			ship.debug_only do
			puts "This is debug output"
			end
			</syntaxhighlight>

			==Block arguments==
			Here is an example of a do..end block
			<syntaxhighlight lang="ruby">

			def produce
			yield :spaceship, :freighter, :yacht, size: :s, seats: :leather
			end

			produce do \| what = :spaceship, *types,
			size: :m, engine_count: 2, **custom_components\|

			puts "Producing #{what}"
			print "Types:"
			p types
			puts "Size: #{size}"
			puts "Engine count: #{engine_count}"
			print "Custom Components"
			p custom_components
			end

			#>Producing spaceship
			#>Types: [:freighter, : yacht]
			#>Size: s
			#>Engine count: 2
			#>Custom components: {:seats=>:leather}
			</syntaxhighlight>
			==Block Context==
			When you invoke a block the context which it was invoked in is present. That is to say the available parameters are still available in the yield.
			<syntaxhighlight lang="ruby">
			$debug = true

			def debug_only
			yield if $debug && block_given
			end

			class Spaceship

			def initialize
			@some_attribute = {containment_status: :ok, core_temp: 350}
			end

			def launch
			debug_only { p @some_attribute}
			end
			end

			ship1 = Spaceship.new
			ship1.launch
			</syntaxhighlight>
			==Example Usage==
			Here is an example usage of block where timings are acquired and perhaps makes more sense for the approach
			<syntaxhighlight lang="ruby">
			def with_timing
			start = Time.now
			if block_given?
			yield
			puts "Time taken: #{Time.now - start} seconds"
			end
			end

			def run_operation_1
			sleep(1)
			end
			def run_operation_2

			with_timing do
			run_operation_1
			run_operation_2
			end

			# output: Time taken: 1.000057 seconds
			</syntaxhighlight>
			==Procs==
			Procs are named blocks. Adding an & to the argument will denote a block is a proc. You can create a proc from a block.
			<syntaxhighlight lang="ruby">
			p = Proc.new {\|bla\|} puts "I am a proc that says #{bla}!" }
			p = proc {\|bla\|} puts "I am a proc that says #{bla}!"}

			# You can invoke them with
			p.call "Yay"!
			p.yield "Wow"
			p.("nothing")
			p["hello"]
			</syntaxhighlight>
			==Lamdas==

	=Exceptions=		=Exceptions=