chain_options 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5632f3b6617e959a1329ae0bba7f1c4c3f24b8678e326a60e2507c07aad97efe
+  data.tar.gz: 1d814bcc04f29d57d614faea7738e38df7ecdc1917016b084c30dd61b57d6d17
+SHA512:
+  metadata.gz: 5f3d50a324399a2a9709c4fbd2308678ba39c882c47460cc5541ef3c5265b21b4c9254c33c5f79368d6b937133274fc7eb5695cea42950a6dfa24957fd2bd38e
+  data.tar.gz: 02d5fc98eb5832186a75618e8b4721a15eb13282942ad12485bde7e7ee0dcc0595d3cf4a94345bd94e3d36bf26c7310758326c808a3eeb907c8e930030c1ae24

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,138 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - tmp/**/*
+
+#---------------------------------------------
+#                   Layout
+#---------------------------------------------
+
+# Hashes do not need padding
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Allow 2 space indentation for when inside a case
+Layout/CaseIndentation:
+  Enabled: false
+
+# Allow empty lines in classes
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Allow multiple spaces before first argument
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+
+# Allow extra spacing, e.g. to align components
+Layout/ExtraSpacing:
+  Enabled: false
+
+# Usually good, but in some cases not possible
+Layout/AlignHash:
+  Enabled: false
+
+# Allow an empty line after do / before end
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# Again, generally a good idea, but it has problems with multiline operations in
+# combination with assignments
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# See the corresponding other cops
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+
+#---------------------------------------------
+#                   Metrics
+#---------------------------------------------
+
+# Allow bigger classes
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowHeredoc: true
+  AllowURI: true
+
+Metrics/BlockLength:
+  Max: 75
+  Exclude:
+    - spec/**/*.rb
+    - lib/chain_options/test_integration/rspec.rb
+
+# Allow longer methods
+Metrics/MethodLength:
+  Enabled: false
+
+# Allow bigger modules
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Exclude:
+    - lib/chain_options/option_set.rb
+
+#---------------------------------------------
+#                   Naming
+#---------------------------------------------
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+#---------------------------------------------
+#                   Style
+#---------------------------------------------
+
+# Allow fail() for initial exception, raise() for re-raise
+# It seems that the cop decision was mainly based on "more people use raise than fail"...
+Style/SignalException:
+  Enabled: false
+
+# Allow assigning multiple variables in one line.
+# This should not be overused, but comes in handy when assigning initializer values to instance variables
+Style/ParallelAssignment:
+  Enabled: false
+
+# Depending on the situation, it might make more sense to use
+# [:symbol1, :symbol2] over %i[symbol1 symbol2], e.g. for multiline aligning reasons.
+Style/SymbolArray:
+  Enabled: false
+
+# Not all modules have to have top level comments
+Style/Documentation:
+  Enabled: false
+
+# Allow class variable usage
+Style/ClassVars:
+  Enabled: false
+
+# Allow block comments
+Style/BlockComments:
+  Enabled: false
+
+# Allow the use of !! (conversion of nil/object to true/false)
+Style/DoubleNegation:
+  Enabled: false
+
+# Allow unless/if blocks even for one-liners
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Style/MethodMissingSuper:
+  Exclude:
+    - lib/chain_options/util.rb

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+sudo: false
+cache: bundler
+
+rvm:
+  - 2.3.0
+  - 2.3.3
+  - 2.4.0
+  - 2.4.4
+  - 2.5.0
+  - 2.5.3
+
+before_install: gem install bundler
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in chain_options.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    chain_options (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    method_source (0.9.2)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    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-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  chain_options!
+  pry (~> 0.12)
+  pry-byebug (~> 3.6)
+  rake (~> 10.0)
+  rspec (~> 3.8)
+  rubocop (~> 0.60)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Stefan Exner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.

data/README.md

@@ -0,0 +1,319 @@
+[![Build Status](https://travis-ci.org/lokalportal/chain_options.svg?branch=master)](https://travis-ci.org/lokalportal/chain_options)
+[![Maintainability](https://api.codeclimate.com/v1/badges/aa9c3e9eb2a02095c587/maintainability)](https://codeclimate.com/github/lokalportal/chain_options/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/aa9c3e9eb2a02095c587/test_coverage)](https://codeclimate.com/github/lokalportal/chain_options/test_coverage)
+
+# ChainOptions
+
+ChainOptions is a small gem which allows you to add non-destructive chainable options to
+your classes. It is useful to incrementally build instances without overriding the previous
+one and provides an easy-to-understand DSL to set options either through 
+method-chaining or in a block.
+
+An example:
+
+```ruby
+class MyItemFeed
+  include ChainOptions::Integration
+  
+  chain_option :page, 
+               default: 1, 
+               invalid: :default, 
+               validate: ->(value) { value.to_i.positive? }
+  
+  chain_option :per_page,
+               default:  30,
+               validate: ->(value) { value.to_i.positive? },
+               invalid:  :default
+end
+
+feed = MyItemFeed.new.build_options do
+  set :page, params[:page]
+  set :per_page, params[:per_page]
+end
+
+# or
+
+feed = MyItemFeed.new.page(params[:page]).per_page(params[:per_page])
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chain_options'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chain_options
+
+## Usage
+
+To use ChainOptions in one of your classes, simply include its integration module:
+
+```ruby
+include ChainOptions::Integration
+```
+
+Afterwards, you're ready to define the options available to instances of your class.
+
+### Basic Options
+
+The easiest way to define an option is to call `chain_option` with just the option name:
+
+```ruby
+class MyClass
+  chain_option :my_option
+end
+```
+
+This will generate the method `#my_option` which is accessible by instances of your class.
+When it's called with an argument, it will return a new instance of your class with 
+the option set to this value, when being called without an argument, it will return the current value.
+
+```ruby
+my_class = MyClass.new #=> Instance 1 of MyClass
+my_class.my_option('my value') #=> Instance 2 of MyClass
+my_class.my_option #=> 'my value'
+``` 
+
+Please note that instance variables are currently not carried over to the new
+instances built when setting a new option.  
+This decision was made to ensure no cached values could be used any more
+after changing an option value:
+
+```ruby
+class Feed
+  chain_option :page
+  chain_option :per_page
+  
+  def entries
+    @entries ||= MyModel.page(page).per(per_page)
+  end
+end
+```
+
+Setting `page` to a different value after `#entries` was called once would not  
+lead to another page being loaded, the return value would stay the same.
+
+This behaviour might be changed in the future, but would only make the gem more complex
+for now.
+
+Array may be passed in as multiple arguments or an Array object, so the following calls are equivalent:
+
+```ruby
+my_object.my_value(1, 2, 3)
+my_option.my_value([1, 2, 3])
+```
+
+### Advanced Options
+
+#### Filters
+
+It is possible to apply filters to option values. As soon as a filter Proc is defined,
+it is assumed that the option value will be an Array.
+
+```ruby
+chain_option :my_even_numbers,
+             filter: -> (number) { number.even? }
+             
+my_object.my_even_numbers(1, 2, 3, 4, 5) #=> [2, 4]
+```
+
+**Note**: As soon as `:filter` is defined, the value will be treated as Array, even if only a single
+element is passed in:
+
+```ruby
+my_object.my_even_numbers(2) #=> [2]
+```
+
+#### Value Validations
+
+It is possible to define validations on the setting value. These are executed whenever a new
+value is set and will either cause an Exception or the option going back to the default value:
+
+```ruby
+chain_option :per_page,
+             validate: -> (value) { value.to_i.positive? },
+             invalid: :raise
+```
+
+The above example ensures that a value set for the `per_page` option has to be positive.
+Otherwise, an `ArgumentError` is raised.
+
+```ruby
+chain_option :per_page,
+             default: 1
+             validate: -> (value) { value.to_i.positive? },
+             invalid: :default
+             
+my_object.per_page(-1).per_page #=> 1 
+```
+
+**Note**: If filters are set up as well, your validation proc will always receive an Array, never a single element.
+
+#### Value Transformations
+
+It is possible to perform automatic transformations (or type casts) on an option value, 
+pretty similar to what ActiveRecord does when e.g. a numeric value is assigned to a string attribute.
+
+As options don't have a type, you have to define the transformation yourself: 
+
+```ruby
+chain_option :my_strings,
+             transform: -> (element) { element.to_s }
+             
+chain_option :my_strings,
+             transform: :to_s
+```
+
+The above calls are equivalent. If a symbol is given, the value (resp. each element of it in case of
+an Array) is expected to respond to a method with the same name.
+
+If the value is an array, the `transform` Proc will receive each item individually.
+
+#### Default Values
+
+It is possible to specify a default value for each option using the `:default` keyword argument.
+The default value is returned in the following cases:
+
+* No custom value was set for the option yet
+* The value set for the option is invalid and the option is set to use the default value instead (see below)
+
+The default value may either be a Proc which is executed on demand or any kind of Ruby object.
+
+```ruby
+chain_option :per_page,
+             default: -> { SomeStore.get_default_per_page }
+```
+
+#### Incremental Values
+
+Options can be set to increment their value through multiple setter calls:
+
+```ruby
+chain_option :favourite_books, incremental: true
+
+user.favourite_books('Lord of the Rings').favourite_books('The Hobbit')
+#=> [['Lord of the Rings'], ['The Hobbit]]
+```
+
+As the values should still be separateable, the elements which were added in each
+setter call are wrapped in another array instead of just appending them to the collection.
+Otherwise, it wouldn't be possible to determine that the following value was caused by two sets:
+
+```ruby
+user.favourite_books('Momo', 'Neverending Story').favourite_books('Lord of the Rings', 'The Hobbit')
+#=> [["Momo", "Neverending Story"], ["Lord of the Rings", "The Hobbit"]]
+```
+
+#### Blocks as option values
+
+If your option accepts blocks as values, setting this to `true` allows you to use the block syntax
+to set a new option value instead of having to pass in a lambda function or Proc object:
+
+```ruby
+chain_option :my_proc, allow_block: true
+
+my_object = my_object.my_proc do
+  # ...
+end
+
+my_object.my_proc #=> <#Proc...>
+```
+
+## Option Testing
+
+ChainOptions comes with basic RSpec integration by providing custom matchers.
+
+To use them, simply require the corresponding module and include it in your specs:
+
+```ruby
+require 'chain_options/test_integration/rspec'
+
+subject { MyClass.new }
+
+describe 'my_option' do
+    include ChainOptions::TestIntegration::Rspec
+    
+    it { is_expected.to have_chain_option(:my_option) }
+end
+```
+
+Every matcher call starts with `have_chain_option` which ensures the the given
+object actually has access to a chain option with the given name.
+
+### Value Acceptance
+
+To test for values which should raise an exception when being set as a chain option value,
+continue the matcher as follows:
+
+```ruby
+it { is_expected.to have_chain_option(:my_option).which_takes(42).and_raises_an_exception } 
+```
+
+This matcher can only fail if the option is set to `invalid: :raise`.
+
+### Value Filters / Transformations
+
+To test whether the option is actually set to the correct value after passing an object to it,
+continue the matcher as follows:
+
+```ruby
+it { is_expected.to have_chain_option(:my_option).which_takes(42).and_sets_it_as_value }
+```
+
+If you expect the option to perform a filtering and/or transformation, you can also
+specify the actual value you expect to be set:
+
+```ruby
+it { is_expected.to have_chain_option(:my_option).which_takes(42).and_sets("42").as_value }
+```
+
+### Default Value
+
+To test whether the option has a certain default value, continue the matcher as follows:
+
+```ruby
+it { is_expected.to have_chain_option(:my_option).with_the_default_value(21) }
+```
+
+### Basic Testing
+
+If you can't or don't want to use the custom matchers, you could define your own helper
+methods to keep your option tests readable:
+
+```ruby
+def expect_to_eql(name, value, expected)
+  expect(subject.send(name, value).send(name)).to eql expected
+end
+
+def expect_to_raise(name, value)
+  expect { subject.send(name, value) }.to raise_error(ArgumentError, /not valid/),
+                                          "`#{value.inspect}` should not be a valid value for option `#{name}`"
+end
+
+it { expect_to_eql :my_option, 42, '42' }
+it { expect_to_raise :my_option, Object.new }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lokalportal/chain_options.  
+For pull request, please follow [git-flow](https://danielkummer.github.io/git-flow-cheatsheet/) naming conventions.  
+ 
+This project is intended to be a safe, welcoming space for collaboration, 
+and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ChainOptions project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chain_options/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'chain_options'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chain_options.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chain_options/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chain_options'
+  spec.version       = ChainOptions::VERSION
+  spec.authors       = ['Stefan Exner']
+  spec.email         = ['stex@sterex.de']
+
+  spec.summary       = 'DSL to add non(destructive).option(methods).to(objects)'
+  spec.homepage      = 'https://github.com/lokalportal/chain_options'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = ['>= 2.3', '< 3']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rubocop', '~> 0.60'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end