smart_init 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2e9bc1d28d5b3b07938020072647cc8a68a79992f1f82b849ad0626c589a284
-  data.tar.gz: cc813ca9b90f91f72c94d713fc661d2c7810d761d45734ceec2218f2f39e3dbb
+  metadata.gz: 7a0d2189c40504fff065e0606ff59bb2c529ea2df100a5d835ae88ba1b89abea
+  data.tar.gz: 536894bb01f7dca209c6686bf0ac7e6960ca257069608e737731f01dd0c36a48
 SHA512:
-  metadata.gz: 9ff873c3e7fee704df155ebacb862a92c663c9c5613535a1c77d6fd91e07d3f086081abb22915d415ee5bc8774882e00af06d42a0bfa371f4a67fb2611cb9798
-  data.tar.gz: 4b8e6651302c3b18b25caa8ce2cc392fdb65089f5d5c56c020af31b6e0e47d9b79090d1965b8d2248951678bed8c5a2e97562a708ba7f5fa67ea32f080aeb5de
+  metadata.gz: d54eea8c78672566034ac4401764942b760a1f39b3be1b69fec278537a2573ad027ccb19c74d1e2e3a2f5d4248b743eb8eff76d0f15ce6560245d06b924bf0fb
+  data.tar.gz: 65aa81859e5589a1ee31f6f0d7ec119ab46570b3aa6167bccac2355dad097e68be337fc6ee3f8afec58d2b4b385a34c0ebabe3977273ce5bd09b632e6979ea19

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)
 
-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.
 
@@ -141,12 +141,83 @@ 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...>)
+```
+
+### 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,  default values and public readers support:
+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/main.rb

@@ -11,41 +11,28 @@ module SmartInit
     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) || {}
+  def initialize_with_hash(*required_attrs, **attributes_and_options)
 
-    define_method :initialize do |*parameters|
-      parameters = [{}] if parameters == []
-      unless parameters.first.is_a?(Hash)
-        raise ArgumentError, "invalid input, expected hash of attributes"
-      end
+    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)
@@ -53,18 +40,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
 

data/lib/smart_init/version.rb

@@ -1,3 +1,3 @@
 module SmartInit
-  VERSION = "4.1.1"
+  VERSION = "4.2.0"
 end

data/test/test_hash_public_accessors.rb

@@ -0,0 +1,72 @@
+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,81 @@
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_init
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2020-04-12 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