sinclair 1.3.0 → 1.3.1

data/spec/lib/sinclair/method_definition/block_definition_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::MethodDefinition::BlockDefinition do
+  let(:klass)    { Class.new }
+  let(:instance) { klass.new }
+
+  describe '#build' do
+    subject(:method_definition) do
+      described_class.new(method_name) do
+        @x = @x.to_i + 1
+      end
+    end
+
+    let(:method_name) { :the_method }
+
+    it_behaves_like 'MethodDefinition#build without cache'
+
+    context 'with cached options' do
+      subject(:method_definition) do
+        described_class.from(method_name, cached: cached_option) do
+          @x = @x.to_i + 1
+        end
+      end
+
+      it_behaves_like 'MethodDefinition#build with cache options'
+    end
+  end
+end

data/spec/lib/sinclair/method_definition/string_definition_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::MethodDefinition::StringDefinition do
+  let(:klass)    { Class.new }
+  let(:instance) { klass.new }
+
+  describe '#build' do
+    subject(:method_definition) do
+      described_class.new(method_name, code)
+    end
+
+    let(:method_name) { :the_method }
+
+    let(:code) { '@x = @x.to_i + 1' }
+
+    it_behaves_like 'MethodDefinition#build without cache'
+
+    context 'with cached options' do
+      subject(:method_definition) do
+        described_class.from(method_name, code, cached: cached_option)
+      end
+
+      it_behaves_like 'MethodDefinition#build with cache options'
+    end
+  end
+end

data/spec/lib/sinclair/method_definition_spec.rb

@@ -2,32 +2,6 @@
 
 require 'spec_helper'
 
-shared_examples 'MethodDefinition#build' do
-  it do
-    expect { method_definition.build(klass) }.to add_method(method_name).to(klass)
-  end
-
-  describe 'after build' do
-    before do
-      method_definition.build(klass)
-    end
-
-    it 'adds the method to the klass instance' do
-      expect(instance).to respond_to(method_name)
-    end
-
-    it 'evaluates return of the method within the instance context' do
-      expect(instance.the_method).to eq(1)
-    end
-
-    it 'evaluates in the context of the instance' do
-      expect { instance.the_method }
-        .to change { instance.instance_variable_get(:@x) }
-        .from(nil).to(1)
-    end
-  end
-end
-
 describe Sinclair::MethodDefinition do
   let(:klass)    { Class.new }
   let(:instance) { klass.new }
@@ -35,70 +9,55 @@ describe Sinclair::MethodDefinition do
   describe '#build' do
     let(:method_name) { :the_method }
 
+    context 'when instantiating the class itself' do
+      subject(:method_definition) do
+        described_class.new(method_name)
+      end
+
+      it do
+        expect { method_definition.build(klass) }.to raise_error(
+          RuntimeError,
+          'Build is implemented in subclasses. ' \
+          "Use #{described_class}.from to initialize a proper object"
+        )
+      end
+    end
+
     context 'when method was defined with a string' do
       subject(:method_definition) do
-        described_class.new(method_name, code)
+        described_class.from(method_name, code)
       end
 
       let(:code) { '@x = @x.to_i + 1' }
 
-      it_behaves_like 'MethodDefinition#build'
-
-      it 'creates a dynamic method' do
-        method_definition.build(klass)
-        expect { instance.the_method }.to change(instance, :the_method)
-          .from(1).to(3)
-      end
+      it_behaves_like 'MethodDefinition#build without cache'
 
       context 'with cached options' do
         subject(:method_definition) do
-          described_class.new(method_name, code, cached: true)
+          described_class.from(method_name, code, cached: cached_option)
         end
 
-        it_behaves_like 'MethodDefinition#build'
-
-        it 'creates a semi-dynamic method' do
-          method_definition.build(klass)
-          expect { instance.the_method }.not_to change(instance, :the_method)
-        end
+        it_behaves_like 'MethodDefinition#build with cache options'
       end
     end
 
     context 'when method was defined with a block' do
       subject(:method_definition) do
-        described_class.new(method_name) do
+        described_class.from(method_name) do
           @x = @x.to_i + 1
         end
       end
 
-      it_behaves_like 'MethodDefinition#build'
-
-      it 'creates a dynamic method' do
-        method_definition.build(klass)
-        expect { instance.the_method }.to change(instance, :the_method)
-          .from(1).to(3)
-      end
+      it_behaves_like 'MethodDefinition#build without cache'
 
       context 'with cached options' do
         subject(:method_definition) do
-          described_class.new(method_name, cached: true) do
+          described_class.from(method_name, cached: cached_option) do
             @x = @x.to_i + 1
           end
         end
 
-        it_behaves_like 'MethodDefinition#build'
-
-        it 'creates a dynamic method' do
-          method_definition.build(klass)
-          expect { instance.the_method }.not_to change(instance, :the_method)
-        end
-
-        it 'sets the instance variable' do
-          method_definition.build(klass)
-          expect { instance.the_method }
-            .to change { instance.instance_variable_get("@#{method_name}") }
-            .from(nil).to(1)
-        end
+        it_behaves_like 'MethodDefinition#build with cache options'
       end
     end
   end

data/spec/support/models/default_value_builder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class DefaultValueBuilder < Sinclair
+  def add_default_values(*methods)
+    default_value = value
+
+    methods.each do |method|
+      add_method(method, cached: cache_type) { default_value }
+    end
+
+    build
+  end
+
+  private
+
+  delegate :accept_nil, :value, to: :options_object
+
+  def cache_type
+    accept_nil ? :full : :simple
+  end
+end

data/spec/support/models/default_valueable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require './spec/support/models/default_value_builder'
+
+module DefaultValueable
+  def default_reader(*methods, value:, accept_nil: false)
+    DefaultValueBuilder.new(
+      self, value: value, accept_nil: accept_nil
+    ).add_default_values(*methods)
+  end
+end

data/spec/support/models/http_json_model.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class HttpJsonModel
+  attr_reader :json
+
+  class << self
+    def parse(attribute, path: [])
+      builder = Sinclair.new(self)
+
+      keys = (path + [attribute]).map(&:to_s)
+
+      builder.add_method(attribute) do
+        keys.inject(hash) { |h, key| h[key] }
+      end
+
+      builder.build
+    end
+  end
+
+  def initialize(json)
+    @json = json
+  end
+
+  def hash
+    @hash ||= JSON.parse(json)
+  end
+end

data/spec/support/models/http_person.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require './spec/support/models/http_json_model'
+
+class HttpPerson < HttpJsonModel
+  parse :uid
+  parse :name,     path: [:personal_information]
+  parse :age,      path: [:personal_information]
+  parse :username, path: [:digital_information]
+  parse :email,    path: [:digital_information]
+end

data/spec/support/models/server.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require './spec/support/models/default_valueable'
+
+class Server
+  extend DefaultValueable
+
+  attr_writer :host, :port
+
+  default_reader :host, value: 'server.com', accept_nil: false
+  default_reader :port, value: 80,           accept_nil: true
+
+  def url
+    return "http://#{host}" unless port
+
+    "http://#{host}:#{port}"
+  end
+end

data/spec/support/shared_examples/method_definition.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-15 00:00:00.000000000 Z
+date: 2019-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -194,6 +194,8 @@ files:
 - 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/string_definition.rb
 - lib/sinclair/options_parser.rb
 - lib/sinclair/version.rb
 - scripts/check_readme.sh
@@ -202,6 +204,7 @@ files:
 - sinclair.jpg
 - spec/integration/readme/my_class_spec.rb
 - spec/integration/readme/my_model_spec.rb
+- 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
@@ -211,6 +214,8 @@ files:
 - 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/options_parser_spec.rb
 - spec/integration/yard/sinclair_spec.rb
@@ -220,16 +225,22 @@ files:
 - spec/lib/sinclair/matchers/add_method_spec.rb
 - spec/lib/sinclair/matchers/add_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_spec.rb
 - spec/lib/sinclair/options_parser_spec.rb
 - spec/lib/sinclair_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixture_helpers.rb
 - spec/support/models/default_value.rb
+- spec/support/models/default_value_builder.rb
+- spec/support/models/default_valueable.rb
 - spec/support/models/dummy_builder.rb
 - spec/support/models/dummy_config.rb
 - spec/support/models/dummy_configurable.rb
 - spec/support/models/dummy_options_parser.rb
+- spec/support/models/http_json_model.rb
+- spec/support/models/http_person.rb
 - spec/support/models/initial_valuer.rb
 - spec/support/models/my_builder.rb
 - spec/support/models/my_class.rb
@@ -239,7 +250,9 @@ files:
 - spec/support/models/my_model.rb
 - spec/support/models/person.rb
 - spec/support/models/purchase.rb
+- spec/support/models/server.rb
 - spec/support/models/validator_builder.rb
+- spec/support/shared_examples/method_definition.rb
 homepage: https://github.com/darthjee/sinclair
 licenses: []
 metadata: {}