smart_init 4.1.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fedc150bbb8aeed53e1bcc08073e643175a5fbe49f909a20c17cac145a95f969
-  data.tar.gz: 71c028b8b52b4ef553fd0d6a5711b913bac1fc8d46e4ca41d067b5e4441a5fa1
+  metadata.gz: 6a6053427e61f4ef731105e0ec9a96799333b652b82c44b875900d61a1a6a1b3
+  data.tar.gz: eb2559ca73adcfe8ad893e9fcf8510ed2bb29229331add6d5f5cdb41b6c99d9e
 SHA512:
-  metadata.gz: e1ec743157b4a687d902d08023654604db4c9ec502448313e9eb79f3e621cb0f43fa293fcba5bcd31018e14cfeb8dd149f937ac89a1cadf1ff0bcb28e226751a
-  data.tar.gz: 681f6bd9c9b9e75580154bde00819894ff3a3f0bbe9598041e21123b4d63284d7d01deda8e374fc462f41d55245c731ee64a70f12380ef2f77f15d2a570ca64f
+  metadata.gz: c36fb8e29eb8f2d78814ed27059bbbe5c5d0f828a97421565f47ac8bbea7e153f70407c589a4576dfc6aba2d238b7d2cba51526ac7343c52fccd47d891dfb86f
+  data.tar.gz: 3c9b8cc59befe99ea87afc76ec287a4d56a2696b557cb30b2854de9f24a4c79bf1ffdd309e6aacd9317c0a5da95d7c4af8c75200e092a74a0d6b6a56c984906c

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 pawurb
+Copyright (c) 2020 Paweł Urbanek
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,6 @@
-# Smart Init [![Build Status](https://travis-ci.org/pawurb/smart_init.svg)](https://travis-ci.org/pawurb/smart_init) [![Gem Version](https://badge.fury.io/rb/smart_init.svg)](https://badge.fury.io/rb/smart_init)
+# Smart Init - Simple service objects in Ruby [![Build Status](https://travis-ci.org/pawurb/smart_init.svg)](https://travis-ci.org/pawurb/smart_init) [![Gem Version](https://badge.fury.io/rb/smart_init.svg)](https://badge.fury.io/rb/smart_init)
 
-Do you find yourself writing a lot of boilerplate code like that?
+Do you find yourself writing a lot of boilerplate code like this?
 
 ```ruby
 def initialize(network_provider, api_token)
@@ -13,7 +13,7 @@ def self.call(network_provider, api_token)
 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.
+This 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 convention 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.
 
@@ -32,6 +32,8 @@ gem 'smart_init'
 You can use it either by extending a module:
 
 ```ruby
+require 'smart_init'
+
 class ApiClient
   extend SmartInit
 
@@ -141,23 +143,76 @@ end
 
 client = SemiPublicApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
 client.network_provider => #<Faraday::Connection:0x000...>
-client.api_token => 'secret_token' => # NoMethodError (private method `api_token' called for #<ApiClient:0x000...>)
+client.api_token => 'secret_token' => # NoMethodError (private method `api_token' called for #<SemiPublicApiClient:0x000...>)
 ```
 
-## Arguments API
+### Accessors access
 
-Alternatively you can use an API without hash arguments,  default values and public readers support:
+Similarly, this is how it would look if you tried to use a writer method:
 
 ```ruby
-class Calculator < SmartInit::Base
-  initialize_with_args :data
-  is_callable
+client = ApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
+client.api_token = 'new_token' => # NoMethodError (private method `api_token=' called for #<ApiClient:0x000..>)
+```
 
-  def call
-    ...
-    result
-  end
+Optionally you can make all or subset of accessors public using the `public_accessors` config option. It accepts `true` or an array of method names as an argument. This will provide both reader and writer methods publicly.
+
+```ruby
+class PublicApiClient < SmartInit::Base
+  initialize_with :network_provider, :api_token, public_accessors: true
 end
 
-Calculator.call(data) => result
+client = PublicApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
+client.network_provider => #<Faraday::Connection:0x000...>
+client.network_provider = Typhoeus::Request.new(...) => #<Typhoeus::Request:0x000...>
+client.api_token => 'secret_token'
+client.api_token = 'new_token' => 'new_token'
+```
+
+```ruby
+class SemiPublicApiClient < SmartInit::Base
+  initialize_with :network_provider, :api_token, public_accessors: [:network_provider]
+end
+
+client = SemiPublicApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
+client.network_provider => #<Faraday::Connection:0x000...>
+client.network_provider = Typhoeus::Request.new(...) => #<Typhoeus::Request:0x000...>
+client.api_token => # NoMethodError (private method `api_token' called for #<SemiPublicApiClient:0x000...>)
+client.api_token = 'new_token' => # NoMethodError (undefined method `api_token=' called for #<SemiPublicApiClient:0x000...>)
+```
+
+Finally, you can mix them together like this:
+
+```ruby
+class PublicReadersSemiPublicAccessorsApiClient < SmartInit::Base
+  initialize_with :network_provider, :api_token, :timeout,
+                  public_readers: true, public_accessors: [:network_provider]
+end
+
+client = PublicReadersSemiPublicAccessorsApiClient.new(
+           network_provider: Faraday.new, api_token: 'secret_token', timeout_length: 100
+         )
+client.network_provider => #<Faraday::Connection:0x000...>
+client.network_provider = Typhoeus::Request.new(...) => #<Typhoeus::Request:0x000...>
+client.api_token => 'secret_token'
+client.api_token = 'new_token' => # NoMethodError (undefined method `api_token=' called for #<SemiPublicApiClient:0x000...>)
+client.timeout_length => 100
+client.timeout_length = 150 => # NoMethodError (undefined method `timeout_length=' called for #<SemiPublicApiClient:0x000...>)
+```
+
+```ruby
+class SemiPublicReadersSemiPublicAccessorsApiClient < SmartInit::Base
+  initialize_with :network_provider, :api_token, :timeout,
+                  public_readers: [:timeout], public_accessors: [:network_provider]
+end
+
+client = SemiPublicReadersSemiPublicAccessorsApiClient.new(
+           network_provider: Faraday.new, api_token: 'secret_token', timeout_length: 100
+         )
+client.network_provider => #<Faraday::Connection:0x000...>
+client.network_provider = Typhoeus::Request.new(...) => #<Typhoeus::Request:0x000...>
+client.api_token => # NoMethodError (private method `api_token' called for #<SemiPublicReadersSemiPublicAccessorsApiClient:0x000...>)
+client.api_token = 'new_token' => # NoMethodError (undefined method `api_token=' called for #<SemiPublicReadersSemiPublicAccessorsApiClient:0x000...>)
+client.timeout_length => 100
+client.timeout_length = 150 => # NoMethodError (undefined method `timeout_length=' called for #<SemiPublicReadersSemiPublicAccessorsApiClient:0x000...>)
 ```

data/lib/smart_init.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'smart_init/main'
 
 module SmartInit

data/lib/smart_init/main.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SmartInit
   def is_callable(opts={})
     method_name = if name_from_opts = opts[:method_name]
@@ -6,46 +8,32 @@ module SmartInit
       :call
     end
 
-    define_singleton_method method_name do |*parameters|
-      new(*parameters).public_send(method_name)
+    define_singleton_method method_name do |**parameters|
+      new(**parameters).public_send(method_name)
     end
   end
 
-  def initialize_with_hash *attributes
-    public_readers_filter = -> (el) {
-      el.is_a?(Hash) && el.keys == [:public_readers]
-    }
-    attributes = attributes.map do |el|
-      if el.is_a?(Hash)
-        el.map { |k, v| { k => v } }
-      else
-       el
-      end
-    end.flatten
-
-    public_readers = attributes.select(&public_readers_filter)
-    attributes.delete_if(&public_readers_filter)
-    required_attrs = attributes.select { |el| el.is_a?(Symbol) }
-
-    default_value_attrs = attributes.select { |el| el.is_a?(Hash) }.reduce(Hash.new, :merge) || {}
-
-    define_method :initialize do |*parameters|
-      parameters = [{}] if parameters == []
-      unless parameters.first.is_a?(Hash)
-        raise ArgumentError, "invalid input, expected hash of attributes"
-      end
+  def initialize_with_hash(*required_attrs, **attributes_and_options)
+    public_readers = attributes_and_options.delete(:public_readers) || []
+    public_accessors = attributes_and_options.delete(:public_accessors) || []
+    if  public_readers == true || public_accessors == true
+      public_readers = required_attrs + attributes_and_options.keys
+      public_accessors = required_attrs + attributes_and_options.keys if public_accessors == true
+    else
+      public_readers += public_accessors
+    end
 
+    define_method :initialize do |**parameters|
       required_attrs.each do |required_attr|
-        unless parameters.first.has_key?(required_attr)
+        unless parameters.has_key?(required_attr)
           raise ArgumentError, "missing required attribute #{required_attr}"
         end
       end
-
-      (required_attrs + default_value_attrs.keys).each do |attribute|
-        value = if parameters.first.has_key?(attribute)
-          parameters.first.fetch(attribute)
+      (required_attrs + attributes_and_options.keys).each do |attribute|
+        value = if parameters.has_key?(attribute)
+          parameters.fetch(attribute)
         else
-          default_value_attrs[attribute]
+          attributes_and_options[attribute]
         end
 
         instance_variable_set("@#{attribute}", value)
@@ -53,44 +41,16 @@ module SmartInit
     end
 
     instance_eval do
-      all_readers = (required_attrs + default_value_attrs.keys).compact
+      all_readers = (required_attrs + attributes_and_options.keys)
       attr_reader(*all_readers)
-
-      if public_readers.count == 0
-        all_readers.each do |method_name|
-          private method_name
-        end
-      elsif public_readers.first.fetch(:public_readers).is_a?(Array)
-        (all_readers - public_readers.first.fetch(:public_readers)).each do |method_name|
-          private method_name
-        end
+      (all_readers - public_readers).each do |reader|
+        private reader
       end
+      attr_writer(*public_accessors)
     end
   end
 
   alias initialize_with initialize_with_hash
-
-  def initialize_with_args *attributes
-    define_method :initialize do |*parameters|
-      if attributes.count != parameters.count
-        raise ArgumentError, "wrong number of arguments (given #{parameters.count}, expected #{attributes.count})"
-      end
-
-      attributes.zip(parameters).each do |pair|
-        name = pair[0]
-        value = pair[1]
-        instance_variable_set("@#{name}", value)
-      end
-    end
-
-    instance_eval do
-      attr_reader(*attributes)
-
-      attributes.each do |method_name|
-        private method_name
-      end
-    end
-  end
 end
 
 class SmartInit::Base

data/lib/smart_init/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SmartInit
-  VERSION = "4.1.0"
+  VERSION = "5.0.1"
 end

data/test/test_hash_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "test/unit"
 require_relative '../lib/smart_init/main'
 

data/test/test_hash_public_accessors.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "byebug"
+require "test/unit"
+require_relative '../lib/smart_init/main'
+
+class TestAllPublicAccessors
+  extend SmartInit
+  initialize_with :attribute_1, :attribute_2, public_accessors: true
+  is_callable
+
+  def call
+    [attribute_1, attribute_2]
+  end
+end
+
+class TestSomePublicAccessors
+  extend SmartInit
+  initialize_with :attribute_1, :attribute_2, public_accessors: [:attribute_1]
+  is_callable
+
+  def call
+    [attribute_1, attribute_2]
+  end
+end
+
+class TestDefaultPublicAccessors
+  extend SmartInit
+  initialize_with :attribute_1, attribute_2: 2, public_accessors: [:attribute_2]
+
+  def call
+    [attribute_1, attribute_2]
+  end
+end
+
+class HashApiPublicTestAccessors < Test::Unit::TestCase
+  def test_all_public
+    service = TestAllPublicAccessors.new(attribute_1: "a", attribute_2: "b")
+    assert_nothing_raised do
+      service.attribute_1 = "c"
+      service.attribute_2 = "d"
+    end
+    assert_equal service.attribute_1, "c"
+    assert_equal service.attribute_2, "d"
+  end
+
+  def test_some_public
+    service = TestSomePublicAccessors.new(attribute_1: "a", attribute_2: "b")
+    assert_nothing_raised do
+      service.attribute_1 = "c"
+    end
+    assert_equal service.attribute_1, "c"
+    assert_raise NoMethodError do
+      service.attribute_2
+    end
+    assert_raise NoMethodError do
+      service.attribute_2 = "d"
+    end
+  end
+
+  def test_default_public
+    service = TestDefaultPublicAccessors.new(attribute_1: "a")
+    assert_nothing_raised do
+      service.attribute_2 = 3
+    end
+    assert_equal service.attribute_2, 3
+    assert_raise NoMethodError do
+      service.attribute_1 = "b"
+    end
+    assert_raise NoMethodError do
+      service.attribute_1
+    end
+  end
+end

data/test/test_hash_public_mixed.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "byebug"
+require "test/unit"
+require_relative '../lib/smart_init/main'
+
+class TestSomePublicMixed
+  extend SmartInit
+  initialize_with :attribute_1, :attribute_2, :attribute_3, :attribute_4,
+                  public_readers: [:attribute_1],
+                  public_accessors: [:attribute_2, :attribute_3]
+  is_callable
+
+  def call
+    [attribute_1, attribute_2, attribute_3, attribute_4]
+  end
+end
+
+class TestAllReadersSomeAccessorsPublic
+  extend SmartInit
+  initialize_with :attribute_1, :attribute_2, public_readers: true, public_accessors: [:attribute_2]
+
+  def call
+    [attribute_1, attribute_2]
+  end
+end
+
+class HashApiPublicTest < Test::Unit::TestCase
+
+  def test_readers_some_public_mixed
+    service = TestSomePublicMixed.new(
+                attribute_1: "a", attribute_2: "b",
+                attribute_3: "c", attribute_4: "d"
+              )
+    assert_nothing_raised do
+      service.attribute_1
+      service.attribute_2
+      service.attribute_3
+    end
+    assert_raise NoMethodError do
+      service.attribute_4
+    end
+  end
+
+  def test_writers_some_public_mixed
+    service = TestSomePublicMixed.new(
+                attribute_1: "a", attribute_2: "b",
+                attribute_3: "c", attribute_4: "d"
+              )
+    assert_nothing_raised do
+      service.attribute_2 = "e"
+      service.attribute_3 = "f"
+    end
+    assert_equal service.attribute_2, "e"
+    assert_equal service.attribute_3, "f"
+    assert_raise NoMethodError do
+      service.attribute_4 = "g"
+    end
+  end
+
+  def test_readers_all_readers_some_accessors_public
+    service = TestAllReadersSomeAccessorsPublic.new(
+                attribute_1: "a", attribute_2: "b"
+              )
+    assert_nothing_raised do
+      service.attribute_1
+      service.attribute_2
+    end
+  end
+
+  def test_writers_all_readers_some_accessors_public
+    service = TestAllReadersSomeAccessorsPublic.new(
+                attribute_1: "a", attribute_2: "b"
+              )
+    assert_raise NoMethodError do
+      service.attribute_1 = "c"
+    end
+    assert_nothing_raised do
+      service.attribute_2 = "d"
+    end
+    assert_equal service.attribute_2, "d"
+  end
+end

data/test/test_hash_public_readers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "byebug"
 require "test/unit"
 require_relative '../lib/smart_init/main'
@@ -31,6 +33,15 @@ class TestDefaultPublic
   end
 end
 
+class TestDefaultAllPublic
+  extend SmartInit
+  initialize_with :attribute_1, attribute_2: 2, public_readers: true
+
+  def call
+    [attribute_1, attribute_2]
+  end
+end
+
 class HashApiPublicTest < Test::Unit::TestCase
   def test_all_public
     service = TestAllPublic.new(attribute_1: "a", attribute_2: "b")
@@ -54,5 +65,11 @@ class HashApiPublicTest < Test::Unit::TestCase
       service.attribute_1
     end
   end
+
+  def test_default_all_public
+    service = TestDefaultAllPublic.new(attribute_1: "a")
+    assert_equal service.attribute_1, "a"
+    assert_equal service.attribute_2, 2
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_init
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.1
 platform: ruby
 authors:
 - pawurb
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -69,14 +69,15 @@ files:
 - lib/smart_init/main.rb
 - lib/smart_init/version.rb
 - smart_init.gemspec
-- test/test_args_api.rb
 - test/test_hash_api.rb
+- test/test_hash_public_accessors.rb
+- test/test_hash_public_mixed.rb
 - test/test_hash_public_readers.rb
 homepage: http://github.com/pawurb/smart_init
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,11 +92,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Remove Ruby initializer boilerplate code
 test_files:
-- test/test_args_api.rb
 - test/test_hash_api.rb
+- test/test_hash_public_accessors.rb
+- test/test_hash_public_mixed.rb
 - test/test_hash_public_readers.rb

data/test/test_args_api.rb

@@ -1,77 +0,0 @@
-require "test/unit"
-require_relative '../lib/smart_init/main'
-
-class TestClass
-  extend SmartInit
-  initialize_with_args :attribute_1, :attribute_2
-  is_callable
-
-  def call
-    [attribute_1, attribute_2]
-  end
-end
-
-class TestNoInit
-  extend SmartInit
-  is_callable
-
-  def call
-    'result'
-  end
-end
-
-class TestMethodName
-  extend SmartInit
-
-  is_callable method_name: :run!
-
-  def run!
-    true
-  end
-end
-
-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(
-        "attr_1_value",
-        "attr_2_value"
-      )
-    end
-
-    assert_raise ArgumentError do
-      TestClass.new(
-        "attr_1_value"
-      )
-    end
-  end
-
-  def test_instance_variables
-    assert_equal test_object.instance_variable_get("@attribute_1"), "attr_1_value"
-  end
-
-  def test_private_getters
-    error = assert_raise NoMethodError do
-      test_object.attribute_1
-    end
-    assert_match("private method", error.message)
-
-    assert_equal test_object.send(:attribute_1), "attr_1_value"
-  end
-
-  def test_is_callable
-    assert_equal TestClass.call("a", "b"), ["a", "b"]
-  end
-
-  def test_is_callable_no_initializers
-    assert_equal TestNoInit.call, 'result'
-  end
-
-  def test_is_callable_method_name
-    assert_equal TestMethodName.run!, true
-  end
-end