sinclair 1.4.1 → 1.4.2

data/spec/lib/sinclair_spec.rb

@@ -149,4 +149,87 @@ describe Sinclair do
       end
     end
   end
+
+  describe '#add_class_method' do
+    context 'when extending the class' do
+      let(:builder_class) { described_class::DummyClassBuilder }
+
+      before do
+        builder.init
+        builder.build
+      end
+
+      context 'when describing a method with block' do
+        it 'creates a method with the block' do
+          expect(dummy_class.blocked).to eq(1)
+        end
+      end
+
+      context 'when describing a method with string' do
+        it 'creates a method using the string definition' do
+          expect(dummy_class.defined).to eq(1)
+          expect(dummy_class.defined).to eq(2)
+        end
+      end
+
+      context 'when passing options' do
+        let(:options) { { increment: 2 } }
+
+        it 'parses the options' do
+          expect(dummy_class.defined).to eq(2)
+          expect(dummy_class.defined).to eq(4)
+        end
+      end
+    end
+
+    context 'when using the builder without extending' do
+      context 'when declaring a method with a block' do
+        before do
+          builder.add_class_method(:blocked) { 1 }
+          builder.add_class_method(:blocked) { 2 }
+          builder.build
+        end
+
+        it 'respect the order of method addtion' do
+          expect(dummy_class.blocked).to eq(2)
+        end
+      end
+
+      context 'when declaring a method string' do
+        before do
+          builder.add_class_method(:string, '1')
+          builder.add_class_method(:string, '2')
+          builder.build
+        end
+
+        it 'respect the order of method addtion' do
+          expect(dummy_class.string).to eq(2)
+        end
+      end
+
+      context 'when declaring block and string' do
+        before do
+          builder.add_class_method(:value) { 1 }
+          builder.add_class_method(:value, '2')
+          builder.build
+        end
+
+        it 'respect the order of method addtion' do
+          expect(dummy_class.value).to eq(2)
+        end
+      end
+
+      context 'when declaring string and block' do
+        before do
+          builder.add_class_method(:value, '1')
+          builder.add_class_method(:value) { 2 }
+          builder.build
+        end
+
+        it 'respect the order of method addtion' do
+          expect(dummy_class.value).to eq(2)
+        end
+      end
+    end
+  end
 end

data/spec/support/models/dummy_class_builder.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class DummyClassBuilder < Sinclair
+    def init
+      add_class_method(:blocked) { 1 }
+      add_class_method(:defined, "@value = value + #{options_object&.increment || 1}")
+      add_class_method(:value, '@value ||= 0')
+    end
+  end
+end

data/spec/support/shared_examples/class_method_definition.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+shared_examples 'ClassMethodDefinition#build' do
+  it do
+    expect { method_definition.build(klass) }
+      .to add_class_method(method_name).to(klass)
+  end
+
+  describe 'after build' do
+    before do
+      method_definition.build(klass)
+    end
+
+    it 'adds the method to the klass' do
+      expect(klass).to respond_to(method_name)
+    end
+
+    it 'evaluates return of the method within the klass context' do
+      expect(klass.the_method).to eq(1)
+    end
+
+    it 'evaluates in the context of the klass' do
+      expect { klass.the_method }
+        .to change { klass.instance_variable_get(:@x) }
+        .from(nil).to(1)
+    end
+  end
+end
+
+shared_examples 'ClassMethodDefinition#build without cache' do
+  it_behaves_like 'ClassMethodDefinition#build'
+
+  it 'creates a dynamic class method' do
+    method_definition.build(klass)
+    expect { klass.the_method }.to change(klass, :the_method)
+      .from(1).to(3)
+  end
+end
+
+shared_examples 'ClassMethodDefinition#build with cache' do
+  it_behaves_like 'ClassMethodDefinition#build'
+
+  it 'creates a semi-dynamic method' do
+    method_definition.build(klass)
+    expect { klass.the_method }.not_to change(klass, :the_method)
+  end
+
+  it 'sets the instance variable' do
+    method_definition.build(klass)
+    expect { klass.the_method }
+      .to change { klass.instance_variable_get("@#{method_name}") }
+      .from(nil).to(1)
+  end
+end
+
+shared_examples 'ClassMethodDefinition#build with cache options' do
+  context 'when cached is true' do
+    let(:cached_option) { true }
+
+    it_behaves_like 'ClassMethodDefinition#build with cache'
+
+    context 'when instance variable has been set as nil' do
+      before do
+        method_definition.build(klass)
+        klass.instance_variable_set(:@the_method, nil)
+      end
+
+      it 'returns a new value' do
+        expect(klass.the_method).to eq(1)
+      end
+    end
+  end
+
+  context 'when cached is full' do
+    let(:cached_option) { :full }
+
+    it_behaves_like 'ClassMethodDefinition#build with cache'
+
+    context 'when instance variable has been set as nil' do
+      before do
+        method_definition.build(klass)
+        klass.instance_variable_set(:@the_method, nil)
+      end
+
+      it 'returns always nil' do
+        expect(klass.the_method).to be_nil
+      end
+    end
+  end
+
+  context 'when cached is false' do
+    let(:cached_option) { false }
+
+    it_behaves_like 'ClassMethodDefinition#build without cache'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-10 00:00:00.000000000 Z
+date: 2019-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,130 +38,214 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.16.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: 5.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: 5.4.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.58.1
+        version: 0.73.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.58.1
+        version: 0.73.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.30.0
+        version: 1.33.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.30.0
+        version: 1.33.0
 - !ruby/object:Gem::Dependency
   name: rubycritic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: 4.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.x
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.x
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.19
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.19
 - !ruby/object:Gem::Dependency
   name: yardstick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.9.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.9.9
 description: Gem for easy concern creation
@@ -194,15 +278,24 @@ files:
 - lib/sinclair/config_factory.rb
 - lib/sinclair/configurable.rb
 - lib/sinclair/matchers.rb
+- lib/sinclair/matchers/add_class_method.rb
+- lib/sinclair/matchers/add_class_method_to.rb
+- lib/sinclair/matchers/add_instance_method.rb
+- lib/sinclair/matchers/add_instance_method_to.rb
 - lib/sinclair/matchers/add_method.rb
 - lib/sinclair/matchers/add_method_to.rb
 - lib/sinclair/method_definition.rb
 - lib/sinclair/method_definition/block_definition.rb
+- lib/sinclair/method_definition/class_block_definition.rb
+- lib/sinclair/method_definition/class_method_definition.rb
+- lib/sinclair/method_definition/class_string_definition.rb
+- lib/sinclair/method_definition/instance_block_definition.rb
+- lib/sinclair/method_definition/instance_method_definition.rb
+- lib/sinclair/method_definition/instance_string_definition.rb
 - lib/sinclair/method_definition/string_definition.rb
+- lib/sinclair/method_definitions.rb
 - lib/sinclair/options_parser.rb
 - lib/sinclair/version.rb
-- scripts/check_readme.sh
-- scripts/rubycritic.sh
 - sinclair.gemspec
 - sinclair.jpg
 - spec/integration/readme/my_class_spec.rb
@@ -210,18 +303,22 @@ files:
 - spec/integration/readme/sinclair/configurable_spec.rb
 - spec/integration/readme/sinclair/matchers_spec.rb
 - spec/integration/readme/sinclair_spec.rb
-- spec/integration/sinclair/matchers_spec.rb
 - spec/integration/yard/my_builder_spec.rb
 - spec/integration/yard/sinclair/config_builder_spec.rb
 - spec/integration/yard/sinclair/config_class_spec.rb
 - spec/integration/yard/sinclair/config_factory_spec.rb
 - spec/integration/yard/sinclair/config_spec.rb
 - spec/integration/yard/sinclair/configurable_spec.rb
-- spec/integration/yard/sinclair/matchers/add_method_spec.rb
-- spec/integration/yard/sinclair/matchers/add_method_to_spec.rb
-- spec/integration/yard/sinclair/method_definition/block_definition_spec.rb
-- spec/integration/yard/sinclair/method_definition/string_definition_spec.rb
-- spec/integration/yard/sinclair/method_definition_spec.rb
+- spec/integration/yard/sinclair/matchers/add_class_method_spec.rb
+- spec/integration/yard/sinclair/matchers/add_class_method_to_spec.rb
+- spec/integration/yard/sinclair/matchers/add_instance_method_spec.rb
+- spec/integration/yard/sinclair/matchers/add_instance_method_to_spec.rb
+- spec/integration/yard/sinclair/method_definition/class_block_definition_spec.rb
+- spec/integration/yard/sinclair/method_definition/class_method_definition_spec.rb
+- spec/integration/yard/sinclair/method_definition/class_string_definition_spec.rb
+- spec/integration/yard/sinclair/method_definition/instance_block_definition_spec.rb
+- spec/integration/yard/sinclair/method_definition/instance_method_definition_spec.rb
+- spec/integration/yard/sinclair/method_definition/instance_string_definition_spec.rb
 - spec/integration/yard/sinclair/options_parser_spec.rb
 - spec/integration/yard/sinclair_spec.rb
 - spec/lib/sinclair/config/methods_builder_spec.rb
@@ -230,11 +327,15 @@ files:
 - spec/lib/sinclair/config_factory_spec.rb
 - spec/lib/sinclair/config_spec.rb
 - spec/lib/sinclair/configurable_spec.rb
-- spec/lib/sinclair/matchers/add_method_spec.rb
-- spec/lib/sinclair/matchers/add_method_to_spec.rb
+- spec/lib/sinclair/matchers/add_class_method_spec.rb
+- spec/lib/sinclair/matchers/add_class_method_to_spec.rb
+- spec/lib/sinclair/matchers/add_instance_method_spec.rb
+- spec/lib/sinclair/matchers/add_instance_method_to_spec.rb
 - spec/lib/sinclair/matchers_spec.rb
-- spec/lib/sinclair/method_definition/block_definition_spec.rb
-- spec/lib/sinclair/method_definition/string_definition_spec.rb
+- spec/lib/sinclair/method_definition/class_block_definition_spec.rb
+- spec/lib/sinclair/method_definition/class_string_definition_spec.rb
+- spec/lib/sinclair/method_definition/instance_block_definition_spec.rb
+- spec/lib/sinclair/method_definition/instance_string_definition_spec.rb
 - spec/lib/sinclair/method_definition_spec.rb
 - spec/lib/sinclair/options_parser_spec.rb
 - spec/lib/sinclair_spec.rb
@@ -246,6 +347,7 @@ files:
 - spec/support/models/default_value_builder.rb
 - spec/support/models/default_valueable.rb
 - spec/support/models/dummy_builder.rb
+- spec/support/models/dummy_class_builder.rb
 - spec/support/models/dummy_config.rb
 - spec/support/models/dummy_configurable.rb
 - spec/support/models/dummy_options_parser.rb
@@ -265,9 +367,10 @@ files:
 - spec/support/models/server.rb
 - spec/support/models/server_config.rb
 - spec/support/models/validator_builder.rb
+- spec/support/shared_examples/class_method_definition.rb
 - spec/support/shared_examples/config.rb
 - spec/support/shared_examples/config_factory.rb
-- spec/support/shared_examples/method_definition.rb
+- spec/support/shared_examples/instance_method_definition.rb
 homepage: https://github.com/darthjee/sinclair
 licenses: []
 metadata: {}