smart_init 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1446b96b76289a0090e6db9d241ecb6e7b5de6db
-  data.tar.gz: 94a722499a830e6c2801672bab387f5398d99572
+  metadata.gz: b2c532785dd60c1023dcf402b5ae50bc61bdbb3d
+  data.tar.gz: f5df63f9c507164ac2d01065982a8b95743ff63e
 SHA512:
-  metadata.gz: a7d717a769b6ef64d4f40a45de80641c5118f913707abcec203bb715bb455a05aba094984dcafeb08e4d36bfdb87b6274aa88a241f6265fb16ceb23c68a8adfc
-  data.tar.gz: 63c1b848ab85ddcf6f3f8e3ad38258771a23e5c163f41530ffcf7378b45ae76b5ded98753d4fedee3a3c33157e31376b678a2083706fe71c207c6949f66c6158
+  metadata.gz: 158fcaf311d75218bfe9ce6c551c3c18708527c38fc134baabd992af737ec30f4059663abac00b32689c603025f33a03b362c300a50a2a1e683016f7951b8f67
+  data.tar.gz: ba253f3ecccd16e07ecca148fc05bf0a51616aed0821e05aaf67d51ef63cd453f9cae9fe76245ff59aeeb4b6b5178c24b3c6532666d03dcba97350403c2cc754

data/.gitignore

@@ -3,3 +3,5 @@ Gemfile.lock
 pkg/
 *.gem
 coverage/
+.byebug_history
+

data/.travis.yml

@@ -1,5 +1,5 @@
 rvm:
-  - 2.2.0
+  - 2.2.5
   - 2.3.0
   - 2.3.1
   - 2.4.0

data/README.md

@@ -2,7 +2,7 @@
 
 Do you find yourself writing a lot of boilerplate code like that?
 
-``` ruby
+```ruby
 def initialize(network_provider, api_token)
   @network_provider = network_provider
   @api_token = api_token
@@ -11,6 +11,8 @@ end
 
 Gem provides a simple DSL for getting rid of it. It offers an alternative to using `Struct.new` which does not check for number of parameters provided in initializer, exposes getters and instantiates unecessary class instances.
 
+**Smart Init** offers a unified api for stateless service objects, accepting values in initializer and exposing one public class method `call` which instantiates new objects and accepts arguments passed to initializer.
+
 ## Installation
 
 In your Gemfile
@@ -19,7 +21,9 @@ In your Gemfile
 gem 'smart_init'
 ```
 
-Then you can use it either by extending a module:
+## Keyword arguments API
+
+You can use it either by extending a module:
 
 ```ruby
 class ApiClient
@@ -42,7 +46,7 @@ end
 Now you can just:
 
 ```ruby
-object = ApiClient.new(Faraday.new, 'secret_token')
+object = ApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
 # <ApiClient:0x007fa16684ec20 @network_provider=Faraday<...>, @api_token="secret_token">
 ```
 
@@ -60,8 +64,46 @@ class Calculator < SmartInit::Base
   end
 end
 
-Calculator.call(data) => data
+Calculator.call(data: data) => result
+```
+
+### Default arguments
+
+You can use keyword based, default argument values:
+
+```ruby
+class Added < SmartInit::Base
+  initialize_with :num_a, num_b: 2
+  is_callable
+
+  def call
+    num_a + num_b
+  end
+end
+
+Adder.call(num_a: 2) => 4
+Adder.call(num_a: 2, num_b: 3) => 5
+
 ```
 
-It provides a unified api for stateless service objects, accepting values in initializer and exposing one public method `call` which accepts no arguments.
+## Legacy API
+
+Alternatively you can use standard API without keyword arguments:
+
+```ruby
+class Calculator < SmartInit::Base
+  initialize_with :data
+  is_callable
+
+  def call
+    ...
+    result
+  end
+end
+
+Calculator.call(data) => result
+```
+
+This API does not support default argument values though.
+
 

data/lib/smart_init/main.rb

@@ -24,6 +24,43 @@ module SmartInit
       attr_reader *attributes
     end
   end
+
+  def initialize_with_keywords *attributes
+    class_variable_set(:@@_attributes, attributes)
+    @@_attributes = attributes
+
+    required_attrs = attributes.select { |attr| attr.is_a?(Symbol) }
+    default_value_attrs = attributes.select { |attr| attr.is_a?(Hash) }.first || {}
+
+    class_variable_set(:@@_required_attrs, required_attrs)
+    class_variable_set(:@@_default_value_attrs, default_value_attrs)
+    @@_required_attrs = required_attrs
+    @@_default_value_attrs = default_value_attrs
+
+    class_eval <<-METHOD
+      def initialize(#{(@@_required_attrs + @@_default_value_attrs.keys).compact.map { |a| @@_default_value_attrs[a] ? "#{a.to_s}: '#{@@_default_value_attrs.fetch(a)}'" : "#{a}:" }.join(', ')})
+        @@_required_attrs&.each do |attribute|
+          instance_variable_set(
+            "@"+ attribute.to_s,
+            eval(attribute.to_s)
+          )
+        end
+
+        @@_default_value_attrs&.keys.each do |attribute|
+          instance_variable_set(
+            "@"+ attribute.to_s,
+            eval(attribute.to_s)
+          )
+        end
+      end
+    METHOD
+
+    instance_eval do
+      private
+
+      attr_reader *(required_attrs + default_value_attrs&.keys)
+    end
+  end
 end
 
 class SmartInit::Base

data/lib/smart_init/version.rb

@@ -1,3 +1,3 @@
 module SmartInit
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/test/test_keywords_api.rb

@@ -0,0 +1,46 @@
+require "test/unit"
+require "byebug"
+require_relative '../lib/smart_init/main'
+
+class TestKeywords
+  extend SmartInit
+  initialize_with_keywords :attribute_1, :attribute_2
+  is_callable
+
+  def call
+    [attribute_1, attribute_2]
+  end
+end
+
+class TestKeywordsDefaults
+  extend SmartInit
+  initialize_with_keywords :attribute_1, attribute_2: "default_value_2", attribute_3: "default_value_3"
+  is_callable
+
+  def call
+    [attribute_1, attribute_2, attribute_3]
+  end
+end
+
+class KeywordsApiTest < Test::Unit::TestCase
+  def test_keywords
+    assert_equal TestKeywords.call(attribute_1: "a", attribute_2: "b"), ["a", "b"]
+
+    assert_raise ArgumentError do
+      TestKeywords.new(
+        attribute_1: "a"
+      )
+    end
+  end
+
+  def test_keywords_defaults
+    assert_equal TestKeywordsDefaults.call(attribute_1: "a"), ["a", "default_value_2", "default_value_3"]
+    assert_equal TestKeywordsDefaults.call(attribute_1: "a", attribute_2: "b"), ["a", "b", "default_value_3"]
+  end
+
+  private
+
+  def test_object
+    @_test_object ||= TestClass.new("attr_1_value", "attr_2_value")
+  end
+end

data/test/{test_smart_init.rb → test_standard_api.rb}

@@ -1,5 +1,6 @@
 require "test/unit"
-require 'smart_init'
+require "byebug"
+require_relative '../lib/smart_init/main'
 
 class TestClass
   extend SmartInit
@@ -20,7 +21,11 @@ class TestNoInit
   end
 end
 
-class SmartInitTest < Test::Unit::TestCase
+def test_object
+  @_test_object ||= TestClass.new("attr_1_value", "attr_2_value")
+end
+
+class StandardApiTest < Test::Unit::TestCase
   def test_number_of_attributes
     assert_nothing_raised do
       TestClass.new(
@@ -55,12 +60,4 @@ class SmartInitTest < Test::Unit::TestCase
   def test_is_callable_no_initializers
     assert_equal TestNoInit.call, 'result'
   end
-
-  private
-
-  def test_object
-    @_test_object ||= TestClass.new("attr_1_value", "attr_2_value")
-  end
 end
-
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_init
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-28 00:00:00.000000000 Z
+date: 2018-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -55,7 +55,8 @@ files:
 - lib/smart_init/main.rb
 - lib/smart_init/version.rb
 - smart_init.gemspec
-- test/test_smart_init.rb
+- test/test_keywords_api.rb
+- test/test_standard_api.rb
 homepage: http://github.com/pawurb/smart_init
 licenses:
 - MIT
@@ -76,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Remove Ruby initializer boilerplate code