insane_hook 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0a61856275cac8c83baf51f5dbe739af495c2086
-  data.tar.gz: 04f39eb108182f93f346afbd2c164ec36a421fda
+SHA256:
+  metadata.gz: 02b68a08a81d3f28cfad66779ed793df6ce08fcc200f56395f2c4d6bea82d786
+  data.tar.gz: c141a6ee66ed0766c6e36301f020fbdb2ceb4350e17f021b6fd03f7cf543c9fb
 SHA512:
-  metadata.gz: 576f92cee691387c45cc6f06971ade6c8eb2c7113ae14a90e277d732266eae6b2a01656b3d24cc4805e67f7ee421b2e03f40825fbf657937c00206ce2f2a8933
-  data.tar.gz: 40c9e53c80c015a4cf4646449ac7dd41629205e5045ced29ab172ad8967f5139f267334ca2c83a2d9a87dd2faa054fcb86718e2bf0a0de7c9059c25a4217401b
+  metadata.gz: d4280e7a961f0c9d5d442ba93f89dc4bf7da836f96380883306051f12a1227423e69424b9881903c5936bca5b6a4f2dfcbfb758250a4c87a3e749ec2ad4bc172
+  data.tar.gz: 793c51f4be50e4b7af99cba480c64c9fb604230d598428b83b71ff0d6ad9818ec18337b25483f5c0dff930dff3d83b7f8d0c200900f5578dfde36e661b982188

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    insane_hook (0.3.0)
+    insane_hook (0.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -32,4 +32,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -2,6 +2,10 @@
 
 Enjoy the enforcing-DSL of this command-patterny gem.
 
+## Current version
+
+0.4.0
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,47 +25,57 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-class YeOldeTaske
-  include InsaneHook
-  need :some_required_arg
-  allow :some_optional_arg
+class YeOldeTaske < InsaneHook
+  requires :some_required_arg
+  fallbacks :some_optional_arg
 
   call do
-    # attr_readers are available for:
-    # - some_required_arg
-    # - some_optional_arg
     result "meaningful value"
   end
 end
-
-YeOldeTaske.new # => InsaneHook::MissingArgumentError
-
-task = YeOldeTaske.new(some_required_arg: "input") # => YeOldeTaske instance
-task.result # => raises InsaneHook::CommandNotRunError
-task.call # => YeOldeTaske instance
-task.result # => "meaningful value"
 ```
 
+Is equivalent to:
+
 ```ruby
 class YeOldeTaske
-  include InsaneHook
-  need :some_required_arg
-  allow :some_optional_arg
 
-  call do
-    # attr_readers are available for:
-    # - some_required_arg
-    # - some_optional_arg
+  def self.call(**args)
+    new(**args).call
   end
-end
 
-task = YeOldeTaske.new(some_required_arg: 7).call
-task.result # => nil
+  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
 
-# Also
-task = YeOldeTaske.call(some_required_arg: 7)
+  def call
+    result "meaningful value"
+    self
+  end
+
+  def result(arg = InsaneHook::NO_ARG)
+    if arg == InsaneHook::NO_ARG
+      if instance_variable_defined?(:@result)
+        @result
+      else
+        raise InsaneHook::CommandNotRunError
+      end
+    else
+      @result = arg
+    end
+  end
+
+end
 ```
 
+
+## 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.
+
 ## 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.

data/lib/insane_hook.rb

@@ -1,78 +1,25 @@
+require "insane_hook/class_methods"
 require "insane_hook/version"
+require "insane_hook/errors"
 
-module InsaneHook
-  ARGS_VAR = :@@_command
-  REQUIRED_ARGS = :required
-  OPTIONAL_ARGS = :optional
-  RESULT_VAR = :@_result
-  NO_ARG = :_no_value
-  class CommandNotRunError < StandardError ; end
-  class MissingArgumentError < StandardError ; end
+class InsaneHook
+  include InsaneHook::Errors
+  include InsaneHook::Constants
 
-  def self.included(mod)
-    mod.class_variable_set(::InsaneHook::ARGS_VAR, {REQUIRED_ARGS => [], OPTIONAL_ARGS => []})
-    mod.extend(ClassMethods)
-    mod.define_singleton_method(:need, mod.instance_method(:_need))
-    mod.define_singleton_method(:allow, mod.instance_method(:_allow))
-    mod.define_singleton_method(:call, mod.instance_method(:_call))
+  def self.inherited(subclass)
+    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?(::InsaneHook::RESULT_VAR)
-        instance_variable_get(::InsaneHook::RESULT_VAR)
+      if instance_variable_defined?(RESULT_VAR)
+        instance_variable_get(RESULT_VAR)
       else
         raise CommandNotRunError
       end
     else
-      instance_variable_set(::InsaneHook::RESULT_VAR, value)
-    end
-  end
-
-  def _need(key)
-    fail "#{key} is not a symbol" unless key.is_a? Symbol
-    args = self.class_variable_get(::InsaneHook::ARGS_VAR)
-    args[REQUIRED_ARGS] << key
-    self.class_variable_set(::InsaneHook::ARGS_VAR, args)
-  end
-
-  def _allow(key)
-    fail "#{key} is not a symbol" unless key.is_a? Symbol
-    args = self.class_variable_get(::InsaneHook::ARGS_VAR)
-    args[OPTIONAL_ARGS] << key
-    self.class_variable_set(::InsaneHook::ARGS_VAR, args)
-  end
-
-  def _call(**args, &block)
-    if block_given?
-      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
-    else
-      new(**args).call
-    end
-
-  end
-
-  module ClassMethods
-    def new(**args)
-      obj = self.allocate
-      self.class_variable_get(::InsaneHook::ARGS_VAR)[REQUIRED_ARGS].each do |var|
-        value = args.fetch(var) { raise(::InsaneHook::MissingArgumentError, "#{var} not provided in #{self.class}") }
-        obj.instance_variable_set("@#{var}", value)
-        obj.class.class_eval{attr_reader var}
-      end
-      self.class_variable_get(::InsaneHook::ARGS_VAR)[OPTIONAL_ARGS].each do |var|
-        value = args.fetch(var, nil)
-        obj.instance_variable_set("@#{var}", value)
-        obj.class.class_eval{attr_reader var}
-      end
-      obj.send :initialize
-      obj
+      instance_variable_set(RESULT_VAR, value)
     end
   end
 end

data/lib/insane_hook/class_methods.rb

@@ -0,0 +1,53 @@
+require "insane_hook/constants"
+require "insane_hook/errors"
+
+class InsaneHook
+  module ClassMethods
+    include Constants
+    include Errors
+
+    def new(**args)
+      obj = self.allocate
+      self.class_variable_get(ARGS_VAR)[REQUIRED_ARGS].each do |var|
+        value = args.fetch(var) { raise(MissingArgumentError, "#{var} not provided in #{self.class}") }
+        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)
+        obj.instance_variable_set("@#{var}", value)
+        obj.class.class_eval{attr_reader var}
+      end
+      obj.send :initialize
+      obj
+    end
+
+    def requires(key)
+      fail "#{key} is not a symbol" unless key.is_a? Symbol
+      args = self.class_variable_get(ARGS_VAR)
+      args[REQUIRED_ARGS] << key
+      self.class_variable_set(ARGS_VAR, args)
+    end
+
+    def fallbacks(key)
+      fail "#{key} is not a symbol" unless key.is_a? Symbol
+      args = self.class_variable_get(ARGS_VAR)
+      args[OPTIONAL_ARGS] << key
+      self.class_variable_set(ARGS_VAR, args)
+    end
+
+    def call(**args, &block)
+      if block_given?
+        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
+      else
+        new(**args).call
+      end
+    end
+  end
+end

data/lib/insane_hook/constants.rb

@@ -0,0 +1,9 @@
+class InsaneHook
+  module Constants
+    ARGS_VAR = :@@_command
+    REQUIRED_ARGS = :required
+    OPTIONAL_ARGS = :optional
+    RESULT_VAR = :@_result
+    NO_ARG = :_no_value
+  end
+end

data/lib/insane_hook/errors.rb

@@ -0,0 +1,8 @@
+class InsaneHook
+  module Errors
+    class CommandNotRunError < StandardError
+    end
+    class MissingArgumentError < StandardError
+    end
+  end
+end

data/lib/insane_hook/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insane_hook
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Aldric Giacomoni, Ahmad Ragab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,9 @@ files:
 - bin/setup
 - insane_hook.gemspec
 - lib/insane_hook.rb
+- lib/insane_hook/class_methods.rb
+- lib/insane_hook/constants.rb
+- lib/insane_hook/errors.rb
 - lib/insane_hook/version.rb
 homepage: https://github.com/Trevoke/insane-hook
 licenses:
@@ -94,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Another implementation of the command pattern that provides a DSL.