smart_init 4.0.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5bd5f6cfd9709e9378b01463ba8473b77aa3c1b17caf8fdbf5743ec26d506a
-  data.tar.gz: 756791cbea14b145fddb9b2b3d96a7c4b595bc3dea91c8998e78f26802b6d323
+  metadata.gz: 87c97f355f94cafbe2dc57c0c4894ecc2dbc916795d6f9789841a94f88cccd08
+  data.tar.gz: 1fae85e561e47465fee2b2c34520987d6d4517c8466061adc4da85093baca94f
 SHA512:
-  metadata.gz: 4b5e72ebb4d1eb6299db75ccd64ef4e8189ad0047ceb64106baddfff678fc80ec33da75adb7dd8a92553df62aaa5005825715f2e89cbae630d6f65230fe88a92
-  data.tar.gz: f4286bc008ec50a1519c0bb3b33bedd67b44db78bb4e27e72592a3843db2163a345af4bcf38d8261fe492961fa0f48d8b36f1f5cd3c3a32595171666b4e74054
+  metadata.gz: b35c0abc26085a6008d0d34d878dfc4c1da3285cae60c052428a243af0bb68fe3c0f17fd660cf5e4cadb20ea3cf3adfbfe26771fcf76d025ecb037f483bbfdfa
+  data.tar.gz: ee1805b175baacf1476a8ef6a2ced3313279eae99b56f82dbf8ffc2f090a822fcd6af7f9870e8f3c11074371e2f5e7ef81a4605ba875c40b0c94147be25740bf

data/.travis.yml

@@ -1,7 +1,7 @@
 rvm:
-  - 2.4.4
   - 2.5.3
   - 2.6.5
+  - 2.7.0
 notifications:
   email: false
 

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)](http://badge.fury.io/rb/smart_init)
+# 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)
 
-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.
 
@@ -37,7 +37,6 @@ class ApiClient
 
   initialize_with :network_provider, :api_token
 end
-
 ```
 
 or subclassing:
@@ -46,7 +45,6 @@ or subclassing:
 class ApiClient < SmartInit::Base
   initialize_with :network_provider, :api_token
 end
-
 ```
 
 Now you can just:
@@ -64,41 +62,9 @@ client = ApiClient.new(network_provider: Faraday.new)
 # ArgumentError (missing required attribute api_token)
 ```
 
-### Readers access
-
-Contrary to using Struct, by default the reader methods are not publicly exposed:
-
-```ruby
-client = ApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
-client.api_token => # NoMethodError (private method `api_token' called for #<ApiClient:0x000..>)
-
-```
-
-Optionally you can make all or subset of readers public using the `public_readers` config option. It accepts `true` or an array of method names as an argument.
-
-```ruby
-class PublicApiClient < SmartInit::Base
-  initialize_with :network_provider, :api_token, public_readers: true
-end
-
-client = ApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
-client.network_provider => #<Faraday::Connection:0x000...>
-client.api_token => 'secret_token'
-```
-
-```ruby
-class SemiPublicApiClient < SmartInit::Base
-  initialize_with :network_provider, :api_token, public_readers: [:network_provider]
-end
-
-client = ApiClient.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...>)
-```
-
 ### Making the object callable
 
-You can also use `is_callable` method:
+You can use the `is_callable` method:
 
 ```ruby
 class Calculator < SmartInit::Base
@@ -145,12 +111,113 @@ end
 
 Adder.call(num_a: 2) => 4
 Adder.call(num_a: 2, num_b: 3) => 5
+```
+
+### Readers access
+
+Contrary to using Struct, by default the reader methods are not publicly exposed:
+
+```ruby
+client = ApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
+client.api_token => # NoMethodError (private method `api_token' called for #<ApiClient:0x000..>)
+```
+
+Optionally you can make all or subset of readers public using the `public_readers` config option. It accepts `true` or an array of method names as an argument.
+
+```ruby
+class PublicApiClient < SmartInit::Base
+  initialize_with :network_provider, :api_token, public_readers: true
+end
+
+client = PublicApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
+client.network_provider => #<Faraday::Connection:0x000...>
+client.api_token => 'secret_token'
+```
+
+```ruby
+class SemiPublicApiClient < SmartInit::Base
+  initialize_with :network_provider, :api_token, public_readers: [:network_provider]
+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 #<SemiPublicApiClient:0x000...>)
+```
+
+### Accessors access
+
+Similarly, this is how it would look if you tried to use a writer method:
+
+```ruby
+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..>)
+```
+
+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
+
+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...>)
 ```
 
 ## Arguments API
 
-Alternatively you can use an API without hash arguments and default values:
+Alternatively you can use an API without hash arguments, default values, public readers, or public accessors support:
 
 ```ruby
 class Calculator < SmartInit::Base

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]
@@ -11,34 +13,28 @@ module SmartInit
     end
   end
 
-  def initialize_with_hash *attributes
-    public_readers_filter = -> (el) {
-      el.is_a?(Hash) && el.keys == [:public_readers]
-    }
-    public_readers = attributes.select(&public_readers_filter)
-    attributes.delete_if(&public_readers_filter)
-    required_attrs = attributes.select { |attr| attr.is_a?(Symbol) }
-
-    default_value_attrs = attributes.select { |attr| attr.is_a?(Hash) }.first || {}
-
-    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
+      public_accessors = required_attrs 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)
@@ -46,18 +42,12 @@ 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
 
@@ -77,9 +67,11 @@ module SmartInit
     end
 
     instance_eval do
-      private
-
       attr_reader(*attributes)
+
+      attributes.each do |method_name|
+        private method_name
+      end
     end
   end
 end

data/lib/smart_init/version.rb

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

data/test/test_args_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "test/unit"
 require_relative '../lib/smart_init/main'
 
@@ -55,9 +57,10 @@ class StandardApiTest < Test::Unit::TestCase
   end
 
   def test_private_getters
-    assert_raise NoMethodError do
+    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

data/test/test_hash_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "test/unit"
 require_relative '../lib/smart_init/main'
 
@@ -58,10 +60,12 @@ class HashApiTest < Test::Unit::TestCase
   end
 
   def test_private_readers
-    service = TestServiceDefaults.call(attribute_1: "a")
-    assert_raise NoMethodError do
-      service.attribute_1
+    service = TestServiceDefaults.new(attribute_1: "a")
+    error = assert_raise NoMethodError do
+      service.attribute_2
     end
+
+    assert_match("private method", error.message)
   end
 
   def test_integer_defaults

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 TestAllPublic
+  extend SmartInit
+  initialize_with :attribute_1, :attribute_2, public_accessors: true
+  is_callable
+
+  def call
+    [attribute_1, attribute_2]
+  end
+end
+
+class TestSomePublic
+  extend SmartInit
+  initialize_with :attribute_1, :attribute_2, public_accessors: [:attribute_1]
+  is_callable
+
+  def call
+    [attribute_1, attribute_2]
+  end
+end
+
+class TestDefaultPublic
+  extend SmartInit
+  initialize_with :attribute_1, attribute_2: 2, public_accessors: [:attribute_2]
+
+  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")
+    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 = TestSomePublic.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 = TestDefaultPublic.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'
@@ -22,6 +24,15 @@ class TestSomePublic
   end
 end
 
+class TestDefaultPublic
+  extend SmartInit
+  initialize_with :attribute_1, attribute_2: 2, public_readers: [:attribute_2]
+
+  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")
@@ -36,4 +47,14 @@ class HashApiPublicTest < Test::Unit::TestCase
       service.attribute_2
     end
   end
+
+  def test_default_public
+    service = TestDefaultPublic.new(attribute_1: "a")
+    assert_equal service.attribute_2, 2
+
+    assert_raise NoMethodError do
+      service.attribute_1
+    end
+  end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_init
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.2.1
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-27 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,6 +71,8 @@ files:
 - 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:
@@ -98,4 +100,6 @@ 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