insane_hook 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02b68a08a81d3f28cfad66779ed793df6ce08fcc200f56395f2c4d6bea82d786
-  data.tar.gz: c141a6ee66ed0766c6e36301f020fbdb2ceb4350e17f021b6fd03f7cf543c9fb
+  metadata.gz: af161e7e0ea7b92529311bdd6a93cf3c5be9025c35a34176cbbded0310818653
+  data.tar.gz: 36e3b3f6538c3374323080ec1cd7d87e4620862a5f043c77b087b5c66844beca
 SHA512:
-  metadata.gz: d4280e7a961f0c9d5d442ba93f89dc4bf7da836f96380883306051f12a1227423e69424b9881903c5936bca5b6a4f2dfcbfb758250a4c87a3e749ec2ad4bc172
-  data.tar.gz: 793c51f4be50e4b7af99cba480c64c9fb604230d598428b83b71ff0d6ad9818ec18337b25483f5c0dff930dff3d83b7f8d0c200900f5578dfde36e661b982188
+  metadata.gz: 609cf7608e901df5d52773072a61bcd660fe2824ae58e2abd79d92334e74643de878700ab372faffc78cfe30d092b1ca065dfb30660704882edf2dcdb2618c6a
+  data.tar.gz: 3c3a0aa8040962f2bb5d161e4ed7b232e87dbe73c716fa47c14bf5729cc733ce018304f3b9a19449b5a83fded733f2d408a1e141dd24840322ed682bc446024d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    insane_hook (0.4.0)
+    insane_hook (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/{README.md → README.org}

@@ -1,91 +1,101 @@
-# InsaneHook
+* InsaneHook
 
 Enjoy the enforcing-DSL of this command-patterny gem.
 
-## Current version
+** Current version
 
-0.4.0
+0.5.0
 
-## Installation
+** Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
+#+BEGIN_SRC ruby
 gem 'insane_hook'
-```
+#+END_SRC
 
 And then execute:
 
+#+BEGIN_SRC bash
     $ bundle
+#+END_SRC
 
 Or install it yourself as:
 
+#+BEGIN_SRC bash
     $ gem install insane_hook
+#+END_SRC
 
-## Usage
+** Usage
 
-```ruby
+#+BEGIN_SRC ruby
 class YeOldeTaske < InsaneHook
-  requires :some_required_arg
-  fallbacks :some_optional_arg
-
+  required :arg1, :arg2
+  required :arg0
+  optional :arg3, arg4: 3
+  optional :arg9
   call do
-    result "meaningful value"
+    leak "meaningful value"
   end
 end
-```
+#+END_SRC
 
 Is equivalent to:
 
-```ruby
-class YeOldeTaske
+#+BEGIN_SRC ruby
+  class YeOldeTaske
 
-  def self.call(**args)
-    new(**args).call
-  end
+    def self.call(**args)
+      new(**args).call
+    end
 
-  attr_reader :some_required_arg, :some_optional_arg
-  def initialize(some_required_arg:, some_optional_arg: nil)
-    @some_required_arg = some_required_arg
-    @some_optional_arg = some_optional_arg
-  end
+    attr_reader :arg0, :arg1, :arg2, :arg3, :arg4, :arg9
 
-  def call
-    result "meaningful value"
-    self
-  end
+    def initialize(arg0:, arg1:, arg2:, arg3: nil, arg9: nil, arg4: 3)
+      @arg0 = arg0
+      @arg1 = arg1
+      @arg2 = arg2
+      @arg3 = arg3
+      @arg4 = arg4
+      @arg9 = arg9
+    end
 
-  def result(arg = InsaneHook::NO_ARG)
-    if arg == InsaneHook::NO_ARG
-      if instance_variable_defined?(:@result)
-        @result
+    def call
+      leak "meaningful value"
+      self
+    end
+
+    def leak(arg)
+      @_result = arg
+    end
+
+    def result
+      if instance_variable_defined?(:@_result)
+        @_result
       else
         raise InsaneHook::CommandNotRunError
       end
-    else
-      @result = arg
     end
   end
+#+END_SRC
 
-end
-```
 
 
-## Design decisions
+** Design decisions
 1. Usage of `call` is idiomatic Ruby. Procs and method objects respond to `call`, so we are extending an existing Ruby pattern.
-2. Commands should not return anything, but if you are forced to check a result, then set the result to a single object and work off of that object, for instance if you want to use the command as one of the clauses of a case statement (in which case the result would be a boolean)
-3. Composition is usually better than Inheritance, especially in a language that doesn't support multiple inheritance. Here we need to use inheritance because we are completely taking over both the `.new` and the `#initialize` methods, meaning the object does not truly belong to the person writing the code.
+2. Commands should not return anything (they are not queries), but if you are forced to check a result, then set the result to a single object and work off of that object ("leak" that data out of the command).
+3. Composition is usually better than Inheritance, especially in a language that doesn't support multiple inheritance. Here we need to use inheritance because we are completely taking over both the `.new` and the `#initialize` methods, meaning the object does not truly belong to the person writing the code: the programmer is limited by the provided framework.
 
-## Development
+** Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
+** Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/trevoke/insane_hook.
 
-## License
+** License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/insane_hook.rb

@@ -7,19 +7,19 @@ class InsaneHook
   include InsaneHook::Constants
 
   def self.inherited(subclass)
-    subclass.class_variable_set(ARGS_VAR, {REQUIRED_ARGS => [], OPTIONAL_ARGS => []})
+    subclass.class_variable_set(ARGS_VAR, {REQUIRED_ARGS => [], OPTIONAL_ARGS => {}})
     subclass.extend(InsaneHook::ClassMethods)
   end
 
-  def result(value=NO_ARG)
-    if value == NO_ARG
-      if instance_variable_defined?(RESULT_VAR)
-        instance_variable_get(RESULT_VAR)
-      else
-        raise CommandNotRunError
-      end
+  def leak(arg)
+    instance_variable_set(RESULT_VAR, arg)
+  end
+
+  def result
+    if instance_variable_defined?(RESULT_VAR)
+      instance_variable_get(RESULT_VAR)
     else
-      instance_variable_set(RESULT_VAR, value)
+      raise CommandNotRunError
     end
   end
 end

data/lib/insane_hook/class_methods.rb

@@ -13,8 +13,8 @@ class InsaneHook
         obj.instance_variable_set("@#{var}", value)
         obj.class.class_eval{attr_reader var}
       end
-      self.class_variable_get(ARGS_VAR)[OPTIONAL_ARGS].each do |var|
-        value = args.fetch(var, nil)
+      self.class_variable_get(ARGS_VAR)[OPTIONAL_ARGS].each do |var, val|
+        value = args.fetch(var, val)
         obj.instance_variable_set("@#{var}", value)
         obj.class.class_eval{attr_reader var}
       end
@@ -22,17 +22,23 @@ class InsaneHook
       obj
     end
 
-    def requires(key)
-      fail "#{key} is not a symbol" unless key.is_a? Symbol
+    def required(*keys)
+      fail "#{key} is not a symbol" unless keys.all? { |x| x.is_a? Symbol }
       args = self.class_variable_get(ARGS_VAR)
-      args[REQUIRED_ARGS] << key
+      args[REQUIRED_ARGS] = (args[REQUIRED_ARGS] + keys).uniq
       self.class_variable_set(ARGS_VAR, args)
     end
 
-    def fallbacks(key)
-      fail "#{key} is not a symbol" unless key.is_a? Symbol
+    def optional(*no_values, **with_values)
+      keys = no_values + with_values.keys
+      fail "#{key} is not a symbol" unless keys.all? { |x| x.is_a? Symbol }
       args = self.class_variable_get(ARGS_VAR)
-      args[OPTIONAL_ARGS] << key
+      no_values.each do |optional_arg|
+        args[OPTIONAL_ARGS][optional_arg] ||= nil
+      end
+      with_values.each do |optional_arg, default_value|
+        args[OPTIONAL_ARGS][optional_arg] ||= default_value
+      end
       self.class_variable_set(ARGS_VAR, args)
     end
 
@@ -41,7 +47,6 @@ class InsaneHook
         raise "Block cannot take arguments" if block.arity > 0
         raise "call method already defined" if self.instance_methods.include?(:call)
         define_method(:call) do
-          result(nil)
           instance_eval(&block)
           self
         end

data/lib/insane_hook/version.rb

@@ -1,3 +1,3 @@
 class InsaneHook
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insane_hook
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Aldric Giacomoni, Ahmad Ragab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-22 00:00:00.000000000 Z
+date: 2018-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.md
+- README.org
 - Rakefile
 - bin/console
 - bin/setup