sinclair 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac0a266d5bf3934653eeb107bc0e7305bfffb80b1845be7abe617aef8b910be6
-  data.tar.gz: 978c830d6045dc169d426f07a79e96bdafbd25482ca982636c8244d3348d69e8
+  metadata.gz: b1f884160da67fa0a41d2b19c5fb1f2186b6a5dfb8518e70d7e624667e7d7a35
+  data.tar.gz: aff0a41c90770ec096c19963abfcea8a6435ee0c725ad90a70dedad800b03646
 SHA512:
-  metadata.gz: c62398491d7d08baa0134e5a5bbe0bfc7b964e2deb2e2c2f25db63788069c654d2636d07aa52ed1f653ee9ba9395f70425d5ab58116447f705ff2b54d0e4273e
-  data.tar.gz: a8642cb8a8aaafab6c5ef20663f02bcb7ee629900f463f3dc385e3c27cf3ef8c272221987fac9b6cf26c165ad07e0fa9710fcb1d3fa884d94fabaa9c3602e3d7
+  metadata.gz: 455434bf9a034eb258b6cc52d0ff3f0a1f0d3671f9ca96c9f892d18ef1435946fc982821fcb34b077409b3f05265cbe493d2820e51804c79ca23da5e58d7ee12
+  data.tar.gz: 8360e97280c678e0326b2be9227b16401059c7a8b37b97e3a0b1ffaa2177ffc4bec7df7a01d8dc8eb2accb216a8c68ade20783c3d4b77ce75a7acff9368ac8a0

data/.rubocop.yml

@@ -1,3 +1,4 @@
+require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
 AllCops:
@@ -9,3 +10,26 @@ Metrics/BlockLength:
 
 Metrics/LineLength:
   Max: 100
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+RSpec/AlignLeftLetBrace:
+  Enabled: true
+
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/integration/yard/sinclair/method_definition_spec.rb'
+    - 'spec/lib/sinclair/method_definition_spec.rb'
+
+RSpec/MultipleExpectations:
+  Exclude:
+    - spec/integration/yard/sinclair/method_definition_spec.rb
+    - spec/lib/sinclair_spec.rb
+    - spec/integration/readme/my_model_spec.rb
+
+RSpec/NestedGroups:
+  Max: 4
+  Exclude:
+    - spec/integration/yard/**/*.rb

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-07-10 13:04:21 +0000 using RuboCop version 0.57.2.
+# on 2019-03-29 10:57:21 +0000 using RuboCop version 0.58.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

data/README.md

@@ -3,33 +3,34 @@ Sinclair
 [![Code Climate](https://codeclimate.com/github/darthjee/sinclair/badges/gpa.svg)](https://codeclimate.com/github/darthjee/sinclair)
 [![Test Coverage](https://codeclimate.com/github/darthjee/sinclair/badges/coverage.svg)](https://codeclimate.com/github/darthjee/sinclair/coverage)
 [![Issue Count](https://codeclimate.com/github/darthjee/sinclair/badges/issue_count.svg)](https://codeclimate.com/github/darthjee/sinclair)
+[![Gem Version](https://badge.fury.io/rb/sinclair.svg)](https://badge.fury.io/rb/sinclair)
 
 
 ![sinclair](https://raw.githubusercontent.com/darthjee/sinclair/master/sinclair.jpg)
 
 This gem helps the creation of complex concern with class methods
 
+Yard Documentation
+-------------------
+https://www.rubydoc.info/gems/sinclair/1.2.0
+
 Installation
 ---------------
   - Install it
 
-  ```ruby
-    gem install sinclair
-  ```
+```ruby
+  gem install sinclair
+```
 
   - Or add Sinclairn to your `Gemfile` and `bundle install`:
 
-  ```ruby
-    gem 'sinclair'
-  ```
-
-  ```bash
-    bundle install sinclair
-  ```
+```ruby
+  gem 'sinclair'
+```
 
-Yard Documentation
--------------------
-https://www.rubydoc.info/gems/sinclair/1.1.3
+```bash
+  bundle install sinclair
+```
 
 Usage
 ---------------
@@ -38,93 +39,87 @@ adding methods to your class or by extending it for more complex logics
 
  - Stand Alone usage:
 
-  ```ruby
-
-    class Clazz
-    end
+```ruby
 
-    builder = Sinclair.new(Clazz)
-
-    builder.add_method(:twenty, '10 + 10')
-    builder.add_method(:eighty) { 4 * twenty }
-    builder.build
+  class Clazz
+  end
 
-    instance = Clazz.new
+  builder = Sinclair.new(Clazz)
 
-    puts "Twenty => #{instance.twenty}"
-    puts "Eighty => #{instance.eighty}"
-  ```
+  builder.add_method(:twenty, '10 + 10')
+  builder.add_method(:eighty) { 4 * twenty }
+  builder.build
 
-  ```string
+  instance = Clazz.new
 
-    Twenty => 20
-    Eighty => 80
-  ```
+  puts "Twenty => #{instance.twenty}" # Twenty => 20
+  puts "Eighty => #{instance.eighty}" # Eighty => 80
+```
 
  - Extending the builder
 
-  ```ruby
+```ruby
 
-    class ValidationBuilder < Sinclair
-      delegate :expected, to: :options_object
-
-      def initialize(klass, options={})
-        super
-      end
+  class ValidationBuilder < Sinclair
+    delegate :expected, to: :options_object
 
-      def add_validation(field)
-        add_method("#{field}_valid?", "#{field}.is_a?#{expected}")
-      end
+    def initialize(klass, options={})
+      super
+    end
 
-      def add_accessors(fields)
-        klass.send(:attr_accessor, *fields)
-      end
+    def add_validation(field)
+      add_method("#{field}_valid?", "#{field}.is_a?#{expected}")
     end
 
-    module MyConcern
-      extend ActiveSupport::Concern
+    def add_accessors(fields)
+      klass.send(:attr_accessor, *fields)
+    end
+  end
 
-      class_methods do
-        def validate(*fields, expected_class)
-          builder = ::ValidationBuilder.new(self, expected: expected_class)
+  module MyConcern
+    extend ActiveSupport::Concern
 
-          validatable_fields.concat(fields)
-          builder.add_accessors(fields)
+    class_methods do
+      def validate(*fields, expected_class)
+        builder = ::ValidationBuilder.new(self, expected: expected_class)
 
-          fields.each do |field|
-            builder.add_validation(field)
-          end
+        validatable_fields.concat(fields)
+        builder.add_accessors(fields)
 
-          builder.build
+        fields.each do |field|
+          builder.add_validation(field)
         end
 
-        def validatable_fields
-          @validatable_fields ||= []
-        end
+        builder.build
       end
 
-      def valid?
-        self.class.validatable_fields.all? do |field|
-          public_send("#{field}_valid?")
-        end
+      def validatable_fields
+        @validatable_fields ||= []
       end
     end
 
-    class MyClass
-      include MyConcern
-      validate :name, :surname, String
-      validate :age, :legs, Integer
-
-      def initialize(name: nil, surname: nil, age: nil, legs: nil)
-        @name = name
-        @surname = surname
-        @age = age
-        @legs = legs
+    def valid?
+      self.class.validatable_fields.all? do |field|
+        public_send("#{field}_valid?")
       end
     end
+  end
 
-    instance = MyClass.new
-  ```
+  class MyClass
+    include MyConcern
+    validate :name, :surname, String
+    validate :age, :legs, Integer
+
+    def initialize(name: nil, surname: nil, age: nil, legs: nil)
+      @name = name
+      @surname = surname
+      @age = age
+      @legs = legs
+    end
+  end
+
+  instance = MyClass.new
+```
 
   the instance will respond to the methods
   ```name``` ```name=``` ```name_valid?```
@@ -133,34 +128,62 @@ adding methods to your class or by extending it for more complex logics
   ```legs``` ```legs=``` ```legs_valid?```
   ```valid?```.
 
-  ```ruby
+```ruby
+  valid_object = MyClass.new(
+    name: :name,
+    surname: 'surname',
+    age: 20,
+    legs: 2
+  )
+  valid_object.valid? # returns true
+```
+
+```ruby
+
+  invalid_object = MyClass.new(
+    name: 'name',
+    surname: 'surname',
+    age: 20,
+    legs: 2
+  )
+  invalid_object.valid? # returns false
+```
+
+  - Caching the result
+    If wanted, the result of the method can be stored in an
+    instance variable with the same name
+
+```ruby
+  class MyModel
+    attr_accessor :base, :expoent
+  end
+
+  builder = Sinclair.new(MyModel)
+
+  builder.add_method(:cached_power, cached: true) do
+    base ** expoent
+  end
+
+  # equivalent of builder.add_method(:cached_power) do
+  #   @cached_power ||= base ** expoent
+  # end
 
-    valid_object = MyClass.new(
-      name: :name,
-      surname: 'surname',
-      age: 20,
-      legs: 2
-    )
-    valid_object.valid? # returns true
-  ```
+  builder.build
 
-  ```ruby
+  model.base    = 3
+  model.expoent = 2
 
-    invalid_object = MyClass.new(
-      name: 'name',
-      surname: 'surname',
-      age: 20,
-      legs: 2
-    )
-    invalid_object.valid? # returns false
-  ```
+  model.cached_power # returns 9
+  model.expoent = 3
+  model.cached_power # returns 9 (from cache)
+```
 
 RSspec matcher
 ---------------
 
 You can use the provided matcher to check that your builder is adding a method correctly
 
-  ```ruby
+```ruby
 
   class DefaultValue
     delegate :build, to: :builder
@@ -209,19 +232,19 @@ You can use the provided matcher to check that your builder is adding a method c
       end
     end
   end
-  ```
+```
 
-  ```bash
+```bash
 
-  > bundle exec rspec
-  ```
+> bundle exec rspec
+```
 
-  ```string
+```string
 
-  DefaultValue
-    when the builder runs
-        should add method 'the_method' to #<Class:0x0000000146c160> instances
-    when the builder runs
-        should add method 'the_method' to #<Class:0x0000000143a1b0> instances
+DefaultValue
+  when the builder runs
+      should add method 'the_method' to #<Class:0x0000000146c160> instances
+  when the builder runs
+      should add method 'the_method' to #<Class:0x0000000143a1b0> instances
 
-  ```
+```

data/lib/sinclair.rb

@@ -8,7 +8,7 @@ require 'active_support/all'
 #
 # Builder that add instance methods to a class
 #
-# @example
+# @example Stand alone usage
 #   class MyModel
 #   end
 #
@@ -38,7 +38,7 @@ class Sinclair
   # @param options [Hash] open hash options to be used by builders inheriting from Sinclair
   #   through the Sinclair::OptionsParser concern
   #
-  # @example
+  # @example Preparing builder
   #
   #   class Purchase
   #     def initialize(value, quantity)
@@ -49,9 +49,39 @@ class Sinclair
   #
   #   builder = Sinclair.new(Purchase)
   #
-  # @example
+  # @example Passing building options (Used on subclasses)
   #
-  #   builder = Sinclair.new(Purchase, rescue_error: true)
+  #   class MyBuilder < Sinclair
+  #     def add_methods
+  #       if options_object.rescue_error
+  #         add_safe_method
+  #       else
+  #         add_method(:symbolize) { @variable.to_sym }
+  #       end
+  #     end
+  #
+  #     def add_safe_method
+  #       add_method(:symbolize) do
+  #         begin
+  #           @variable.to_sym
+  #         rescue StandardError
+  #           :default
+  #         end
+  #       end
+  #     end
+  #   end
+  #
+  #   class MyModel
+  #   end
+  #
+  #   builder = MyBuilder.new(MyModel, rescue_error: true)
+  #
+  #   builder.add_method
+  #   builder.build
+  #
+  #   instance = MyModel.new
+  #
+  #   instance.symbolize # returns :default
   def initialize(klass, options = {})
     @klass = klass
     @options = options
@@ -59,7 +89,7 @@ class Sinclair
 
   # builds all the methods added into the klass
   #
-  # @example
+  # @example Adding a default value method
   #
   #   class MyModel
   #   end
@@ -114,13 +144,13 @@ class Sinclair
   #
   #   Person.new('john', 'wick').bond_name # returns 'wick, john wick'
   # @return [Array<MethodDefinition>]
-  def add_method(name, code = nil, &block)
-    definitions << MethodDefinition.new(name, code, &block)
+  def add_method(name, code = nil, **options, &block)
+    definitions << MethodDefinition.new(name, code, **options, &block)
   end
 
   # Evaluetes a block which will result in a String, the method code
   #
-  # @example
+  # @example Building a initial value class method
   #
   #   module InitialValuer
   #     extend ActiveSupport::Concern
@@ -147,7 +177,7 @@ class Sinclair
   #   object.age = 30
   #   object.age # 30
   #
-  # @example
+  # @example Adding option for rescue
   #
   #   class Purchase
   #     def initialize(value, quantity)
@@ -168,7 +198,7 @@ class Sinclair
   #
   #   Purchase.new(2.3, 5).total_price # raises error
   #
-  # @example
+  # @example Using option for rescue
   #
   #   builder = Sinclair.new(Purchase, rescue_error: true)
   #