smart_init 3.5.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51e20a618133427922cb386a3469a77420e95eaf2ad9debaf3f7684a1a0f3e35
-  data.tar.gz: 7441d3d6e5eec084365e041d1b33885489ffe4126ec6e16d8eefa04a28caab7a
+  metadata.gz: 8f5bd5f6cfd9709e9378b01463ba8473b77aa3c1b17caf8fdbf5743ec26d506a
+  data.tar.gz: 756791cbea14b145fddb9b2b3d96a7c4b595bc3dea91c8998e78f26802b6d323
 SHA512:
-  metadata.gz: 48c99e64ba5e5325b3ea9087be3eff565add93252a7a52efddd2810f6b37d255d98b475e97614d7201009636fe5a1d6070309f0cf2e761e5da8b4de72b0ee313
-  data.tar.gz: 2118838699bd2fcd42227041515033d01d790a1d6bcabe44437a0ce95cf0653fbc3c49d42d65a8bc65a708070302df621f79c62e7935d2d1eabd6552cb55f9ec
+  metadata.gz: 4b5e72ebb4d1eb6299db75ccd64ef4e8189ad0047ceb64106baddfff678fc80ec33da75adb7dd8a92553df62aaa5005825715f2e89cbae630d6f65230fe88a92
+  data.tar.gz: f4286bc008ec50a1519c0bb3b33bedd67b44db78bb4e27e72592a3843db2163a345af4bcf38d8261fe492961fa0f48d8b36f1f5cd3c3a32595171666b4e74054

data/README.md

@@ -59,20 +59,45 @@ object = ApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
 If you omit a required attribute an `ArgumentError` will be thrown:
 
 ```ruby
-object = ApiClient.new(network_provider: Faraday.new)
+client = ApiClient.new(network_provider: Faraday.new)
 
 # ArgumentError (missing required attribute api_token)
 ```
 
-Contrary to using Struct, reader methods are not publicly exposed:
+### Readers access
+
+Contrary to using Struct, by default the reader methods are not publicly exposed:
 
 ```ruby
-object = ApiClient.new(network_provider: Faraday.new, api_token: 'secret_token')
-object.api_token
+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
 
-# NoMethodError (private method `api_token' called for #<ApiClient:0x00007fe911876a48>)
+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:
 
 ```ruby

data/lib/smart_init/main.rb

@@ -12,7 +12,13 @@ module SmartInit
   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|
@@ -21,6 +27,7 @@ module SmartInit
         raise ArgumentError, "invalid input, expected hash of attributes"
       end
 
+
       required_attrs.each do |required_attr|
         unless parameters.first.has_key?(required_attr)
           raise ArgumentError, "missing required attribute #{required_attr}"
@@ -39,9 +46,18 @@ module SmartInit
     end
 
     instance_eval do
-      private
+      all_readers = (required_attrs + default_value_attrs.keys).compact
+      attr_reader(*all_readers)
 
-      attr_reader(*(required_attrs + default_value_attrs.keys).compact)
+      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
+      end
     end
   end
 

data/lib/smart_init/version.rb

@@ -1,3 +1,3 @@
 module SmartInit
-  VERSION = "3.5.0"
+  VERSION = "4.0.0"
 end

data/smart_init.gemspec

@@ -16,5 +16,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = "MIT"
   gem.add_development_dependency "rake"
+  gem.add_development_dependency "byebug"
   gem.add_development_dependency "test-unit"
 end

data/test/test_hash_api.rb

@@ -57,6 +57,13 @@ class HashApiTest < Test::Unit::TestCase
     assert_equal TestServiceDefaults.call(attribute_1: "a", attribute_2: "b"), ["a", "b", "default_value_3"]
   end
 
+  def test_private_readers
+    service = TestServiceDefaults.call(attribute_1: "a")
+    assert_raise NoMethodError do
+      service.attribute_1
+    end
+  end
+
   def test_integer_defaults
     assert_equal TestHashIntegerDefaults.call(attribute_1: 1), [1, 2]
   end

data/test/test_hash_public_readers.rb

@@ -0,0 +1,39 @@
+require "byebug"
+require "test/unit"
+require_relative '../lib/smart_init/main'
+
+class TestAllPublic
+  extend SmartInit
+  initialize_with :attribute_1, :attribute_2, public_readers: true
+  is_callable
+
+  def call
+    [attribute_1, attribute_2]
+  end
+end
+
+class TestSomePublic
+  extend SmartInit
+  initialize_with :attribute_1, :attribute_2, public_readers: [:attribute_1]
+  is_callable
+
+  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_equal service.attribute_1, "a"
+    assert_equal service.attribute_2, "b"
+  end
+
+  def test_some_public
+    service = TestSomePublic.new(attribute_1: "a", attribute_2: "b")
+    assert_equal service.attribute_1, "a"
+    assert_raise NoMethodError do
+      service.attribute_2
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_init
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 4.0.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2019-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -57,6 +71,7 @@ files:
 - smart_init.gemspec
 - test/test_args_api.rb
 - test/test_hash_api.rb
+- test/test_hash_public_readers.rb
 homepage: http://github.com/pawurb/smart_init
 licenses:
 - MIT
@@ -76,10 +91,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.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_readers.rb