nxt_init 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e0d3388fecb1cea6337c51e9099379ea524e5d3721177be48c5d2f24777530e
-  data.tar.gz: 43d916b6c32b952f397d16fe4cf45e4459a1fd8edcbc45a14aa3dc79810e7b4c
+  metadata.gz: e476a1496d78ec53eff95f0d9c1ac56938adbd21ff3773ead35cd75142f9e80b
+  data.tar.gz: e4c28f04b5f4bae9b18e63207af4769c312431ec622bbbdf3a3d8c0df9a68a47
 SHA512:
-  metadata.gz: 957b15225b7d1f6a86afae921194555f2a59a40b3d84f1af2c1c3eca1ddf6c18522ab8f85a8ce64051c74abf69108abe218c672acb63ae504c4c9ee393577a4f
-  data.tar.gz: d778870ebbb87532d8696c29668263b143dfd6fc345aad36f01e8644034229ef625a4a73f2e23c270a0d7cb81dccde02dd634f8c138b1ce3f9f0dd855701d24c
+  metadata.gz: 53b5060fe7b794a93c28a0cbee74b5192d4355d1d140330990cd3d88e4574da795dc44d7018cbd0f3095c6970f5a7e231348f19bad48c4c25465492162921cec
+  data.tar.gz: 7f8a523bda1983ace6c0920c41e4f5bbfff06efee3225320c86c9a232c6d404034e91fab98d1d05ff5c4de16a70a31374b47ebb7f044454f4f1bda353999790d

data/.circleci/config.yml

@@ -0,0 +1,52 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.6.1-node
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.ruby-version

@@ -1 +1 @@
-2.6.1
+2.6.3

data/Gemfile

@@ -4,3 +4,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in nxt_init.gemspec
 gemspec
+
+group :test do
+  gem 'rspec_junit_formatter' # for CircleCI
+end

data/Gemfile.lock

@@ -1,41 +1,43 @@
 PATH
   remote: .
   specs:
-    nxt_init (0.1.2)
+    nxt_init (0.1.5)
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     coderay (1.1.2)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    i18n (1.5.3)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     method_source (0.9.2)
     minitest (5.11.3)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
+    rake (12.3.2)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -47,8 +49,9 @@ DEPENDENCIES
   bundler (~> 1.17)
   nxt_init!
   pry
-  rake (~> 10.0)
+  rake (~> 12.3)
   rspec (~> 3.0)
+  rspec_junit_formatter
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -1,3 +1,5 @@
+[![CircleCI](https://circleci.com/gh/nxt-insurance/nxt_init.svg?style=svg)](https://circleci.com/gh/nxt-insurance/nxt_init)
+
 # NxtInit
 
 Create an initializer that accepts option arguments and define private readers for your 
@@ -21,39 +23,72 @@ Or install it yourself as:
 
 ## Usage
 
+NxtInit removes some boilerplate. Instead of writing your initializer and (private) attribute readers each and every time like so:
+
 ```ruby
-class MyService
-    include NxtInit
-    attr_init :one, 
-             two: 'has a default', 
-             three: nil, # makes the attribute optional
-             four: -> { "This is set on initialize: #{Time.now} - means it will not be evaluated multiple times" } 
-             
-    def call
-      {
-        one: one,
-        two: two,
-        three: three,
-        four: four
-      }
-    end
+class GetSafe
+  def initialize(frontend:, backend:)
+    @frontend = frontend
+    @backend = backend
+  end
+  
+  private 
+  
+  attr_reader :frontend, :backend
 end
+```
 
-my_service = MyService.new(one: 'this is required')
-my_service.call
+You can instead do the following:
 
-# Will output the following:
-{
+```ruby
+class GetSafe
+  include NxtInit
+  attr_init :frontend, :backend
+end
 
-  one: "this is required", 
-  two: "has a default", 
-  three: nil, 
-  four: "This is evaluated on initialize: 2019-02-04 18:10:56 +0100 - means it will not be evaluated multiple times"
-} 
+GetSafe.new # KeyError (NxtInit attr_init key :frontend was missing at initialization!
+GetSafe.new(frontend: 'React', backend: 'Ruby on Rails') #<GetSafe:0x00007f81fb8506b8 @frontend="React", @backend="Ruby on Rails">
 ```
 
-The attribute readers are private. If you need public accessors you have to add them yourself. That's all there is.
-Check out the specs for examples how we handle inheritance. 
+### Optional arguments and defaults
+
+In order to provide default values you can simply use the hash syntax to define your defaults. 
+If you want to make an attribute optional, just pass nil as the default argument. 
+If there is no default value and you did not provide one when initializing your class, you will get a KeyError.
+
+```ruby
+class GetSafe
+  include NxtInit
+  attr_init frontend: 'React', 
+            backend: -> { 'Ruby on Rails' }, 
+            middleware: nil
+end
+
+GetSafe.new #<GetSafe:0x00007fab608e1918 @frontend="React", @backend="Ruby on Rails", @middleware=nil>
+```
+
+### Preprocessors
+
+If you want to preprocess your attribute somehow, you can define a preprocessor block to which the original attribute will be yielded.
+Note that you can also call methods in your block if you have some heavier lifting to do.
+
+```ruby
+class GetSafe
+  include NxtInit
+  attr_init date: -> (date) { date && (date.is_a?(Date) ? date : Date.parse(date)) }
+end
+
+GetSafe.new(date: '2020/12/12').send(:date) # will give you the date
+GetSafe.new(date: nil).send(:date) # would give you nil
+GetSafe.new # would raise KeyError (NxtInit attr_init key :date was missing at initialization!)
+```
+
+Also you can still pass in nil if your block can handle it. If the attribute is not provided on initialization again a KeyError will be raised. 
+
+### Inheritance
+
+When you inherit from a class that already includes NxtInit you can add further attributes to your subclass and overwrite existing options
+simply by using attr_init for the same attributes. Check out the specs for more examples.
 
 ## Development
 

data/lib/nxt_init.rb

@@ -1,15 +1,17 @@
 require "nxt_init/version"
-require 'active_support'
+require "nxt_init/option"
+require "nxt_init/not_provided_option"
+require 'active_support/all'
 
 module NxtInit
-  InvalidOptionError = Class.new(ArgumentError)
-
   module ClassMethods
     def attr_init(*args)
-      flat_args = flatten_options(*args)
-      self.attr_init_opts ||= []
-      self.attr_init_opts += flat_args
-      define_private_readers(*flat_args)
+      options_map = build_options_map(*args)
+
+      self.attr_init_opts ||= {}
+      self.attr_init_opts.merge!(options_map)
+
+      define_private_readers(*options_map.keys)
     end
 
     attr_accessor :attr_init_opts
@@ -17,31 +19,29 @@ module NxtInit
     private
 
     def inherited(subclass)
-      subclass.attr_init_opts = attr_init_opts.map(&:dup)
+      subclass.attr_init_opts = attr_init_opts.deep_dup
     end
 
-    def define_private_readers(*args)
-      keys = args.map { |attr| attr.is_a?(Hash) ? attr.keys.first : attr }
+    def define_private_readers(*keys)
       attr_reader *keys
       private *keys
     end
 
-    def flatten_options(*args)
+    def build_options_map(*args)
       options_hash = *args.extract_options!
-      options_hash.each { |key, value| args << {"#{key}": value} }
-      args
+      options_from_args = args.each_with_object({}) { |key, acc| acc[key] = Option.new(key) }
+      options_from_options = options_hash.each_with_object({}) { |(key, value), acc| acc[key] = Option.new(key, default_value: value) }
+      options_from_args.merge(options_from_options)
     end
   end
 
   module InstanceMethods
     def initialize(*args, **attrs)
-      option_keys = self.class.send(:attr_init_opts).map do |option|
-        option.is_a?(Hash) ? option.keys.first : option
-      end
+      option_keys = self.class.send(:attr_init_opts).keys
 
       attr_init_opts = attrs.slice(*option_keys)
       other_options = attrs.slice!(*option_keys)
-      # passing **{} is like calling super({}) which does not work when super does not except arguments
+      # passing **{} is like calling super({}) which does not work when super does not except arguments#
       initialize_attrs_from_options(**attr_init_opts)
       other_options.empty? ? super(*args) : super(*args, **other_options)
     end
@@ -49,39 +49,11 @@ module NxtInit
     private
 
     def initialize_attrs_from_options(**attrs)
-      self.class.send(:attr_init_opts).each do |opt|
-        if opt.is_a?(Hash)
-          key = opt.keys.first
-          default_value = opt.values.first
-          given_value = attrs[key]
-          key_missing = !attrs.key?(key)
-
-          if default_value_is_preprocessor?(default_value)
-            value = key_missing ? raise_key_error(key) : instance_exec(given_value, &default_value)
-          else
-            value = given_value || (default_value.respond_to?(:call) ? instance_exec(&default_value) : default_value)
-          end
-        elsif opt.is_a?(Symbol)
-          key = opt
-          value = attrs.fetch(opt) { |k| raise_key_error(k) }
-        else
-          raise InvalidOptionError, "Don't know how to deal with #{opt}"
-        end
-        instance_variable_set("@#{key}", value)
+      self.class.send(:attr_init_opts).each do |_, opt|
+        value = opt.resolve(attrs, target: self)
+        instance_variable_set("@#{opt.key}", value)
       end
     end
-
-    def default_value_is_block?(default_value)
-      default_value.respond_to?(:call)
-    end
-
-    def default_value_is_preprocessor?(default_value)
-      default_value_is_block?(default_value) && default_value.arity == 1
-    end
-
-    def raise_key_error(key)
-      raise KeyError, "NxtInit attr_init key :#{key} was missing at initialization!"
-    end
   end
 
   def self.included(base)

data/lib/nxt_init/not_provided_option.rb

@@ -0,0 +1,4 @@
+module NxtInit
+  class NotProvidedOption
+  end
+end

data/lib/nxt_init/option.rb

@@ -0,0 +1,56 @@
+module NxtInit
+  class Option
+    InvalidOptionError = Class.new(ArgumentError)
+
+    def initialize(key, default_value: NotProvidedOption.new)
+      @key = key
+      @default_value = default_value
+    end
+
+    attr_reader :key, :default_value
+
+    def resolve(attrs, target:)
+      if default_value_was_given?
+        key_missing = !attrs.key?(key)
+        given_value = attrs[key]
+
+        if default_value_is_preprocessor?
+          key_missing ? raise_key_error : target.instance_exec(given_value, &default_value)
+        else
+          # only when the given value was nil we will evaluate the fallback --> false is a valid value
+          if given_value.nil?
+            default_value_is_block? ? target.instance_exec(&default_value) : default_value
+          else
+            given_value
+          end
+        end
+      elsif requires_value?
+        attrs.fetch(key) { |_| raise_key_error }
+      else
+        raise InvalidOptionError, "Don't know how to deal with #{self}"
+      end
+    end
+
+    def requires_value?
+      !default_value_was_given?
+    end
+
+    def default_value_is_block?
+      default_value && default_value.respond_to?(:call)
+    end
+
+    def default_value_is_preprocessor?
+      default_value_is_block? && default_value.arity == 1
+    end
+
+    def default_value_was_given?
+      !default_value.is_a?(NotProvidedOption)
+    end
+
+    private
+
+    def raise_key_error
+      raise KeyError, "NxtInit attr_init key :#{key} was missing at initialization!"
+    end
+  end
+end

data/lib/nxt_init/version.rb

@@ -1,3 +1,3 @@
 module NxtInit
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/nxt_init.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport"
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_init
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Andreas Robecke
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-26 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,14 +46,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +89,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -101,6 +102,8 @@ files:
 - bin/console
 - bin/setup
 - lib/nxt_init.rb
+- lib/nxt_init/not_provided_option.rb
+- lib/nxt_init/option.rb
 - lib/nxt_init/version.rb
 - nxt_init.gemspec
 homepage: https://github.com/nxt-insurance
@@ -125,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: nxt_init allows you to define an initializer that takes option arguments