lhs 4.2.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97ecd71fe1e08636cbe1a790d4bd8c0787facbdd
-  data.tar.gz: 932f5f517996f854e619f12dbaaea58f21205c20
+  metadata.gz: c11e58cb09f9ff88f5fcc1fe3c89709482fc4089
+  data.tar.gz: b37486d8daa8d33ddd1556f3ce5e02f637d78b54
 SHA512:
-  metadata.gz: b1768124ad016dd853334bd431d267cf45857b68d2964695b4ce0f0475f516bb01d40b3c137a4b2d93fb8d7868ccd29a830e6401953c5a4a979769feb47cd22d
-  data.tar.gz: b6351fc5cfee078fc8c3f64b911548e10ab72a197650f4838a666286715764a457bec28d5710229882553050bfcd84342aad3b4160fb42730adcd0d29cda4212
+  metadata.gz: 8a6fb56d82bb2f1807f60685b74f83226fd3a8c99b1727353e2ac6888b6491febef33c5be0d9e281eed67ddf5d657609b389a4b222150f790e3ec079e618add5
+  data.tar.gz: 821ac2f5ef3c9bd221937243c33634ba5ad4032311bc4f54a9db276a3b3d9ddf3414085749a389b9d4a15b0edcaae36786b53564098e5d7e94b22b5e852fde8f

data/README.md

@@ -66,6 +66,60 @@ This uses the `:datastore/v2/feedbacks` endpoint, cause `:campaign_id` was not p
 
 Uses the `:datastore/v2/content-ads/:campaign_id/feedbacks` endpoint.
 
+## Chaining where statements
+
+LHS supports chaining where statements. 
+That allows you to chain multiple where-queries:
+
+```ruby
+class Record < LHS::Record
+  endpoint 'records/'
+  endpoint 'records/:id'
+end
+
+records = Record.where(color: 'blue')
+...
+records.where(available: true).each do |record|
+  ...
+end
+```
+The example would fetch records with the following parameters: `{color: blue, available: true}`.
+
+## Where values hash
+
+Returns a hash of where conditions.
+Common to use in tests, as where queries are not performing any HTTP-requests when no data is accessed.
+
+```ruby
+records = Record.where(color: 'blue').where(available: true).where(color: 'red')
+
+expect(
+  records
+).to have_requested(:get, %r{records/})
+  .with(query: hash_including(color: 'blue', available: true))
+# will fail as no http request is made (no data requested)
+
+expect(
+  records.where_values_hash
+).to eq {color: 'red', available: true}
+```
+
+## Scopes: Reuse where statements
+
+In order to make common where statements reusable you can organise them in scopes:
+
+```ruby
+class Record < LHS::Record
+  endpoint 'records/'
+  endpoint 'records/:id'
+  scope :blue, -> { where(color: 'blue') }
+  scope :available, ->(state) { where(available: state) }
+end
+
+records = Record.blue.available(true)
+The example would fetch records with the following parameters: `{color: blue, visible: true}`.
+```
+
 ## Find single records
 
 `find` finds a unique record by uniqe identifier (usualy id).

data/lib/lhs/concerns/record/scope.rb

@@ -0,0 +1,23 @@
+require 'active_support'
+
+class LHS::Record
+
+  # Scopes allow you to reuse common where queries
+  module Scope
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def scope(name, block)
+        scopes[name] = block
+        define_singleton_method(name) do |*args|
+          block.call(*args)
+        end
+      end
+
+      def scopes
+        @scopes ||= {}
+        @scopes
+      end
+    end
+  end
+end

data/lib/lhs/concerns/record/where.rb

@@ -5,11 +5,60 @@ class LHS::Record
   module Where
     extend ActiveSupport::Concern
 
+    class WhereChain
+
+      # Instance exec is required for scope chains
+      delegated_methods = Object.instance_methods - [:instance_exec]
+      delegate(*delegated_methods, to: :resolve)
+
+      def initialize(record, parameters)
+        @record = record
+        @chain = [parameters].compact
+      end
+
+      def where(parameters)
+        @chain += [parameters].compact
+        self
+      end
+
+      # Returns a hash of where conditions
+      def where_values_hash
+        merged_parameters
+      end
+
+      protected
+
+      def method_missing(name, *args, &block)
+        scope = @record.scopes[name]
+        return instance_exec(*args, &scope) if scope
+        resolve.send(name, *args, &block)
+      end
+
+      def respond_to_missing?(name, include_all = false)
+        @record.scopes[name] ||
+          resolve.respond_to?(name, include_all)
+      end
+
+      def resolve
+        @resolved ||= @record.new(
+          @record.request(params: merged_parameters)
+        )
+      end
+
+      private
+
+      def merged_parameters
+        merged_parameters = {}
+        @chain.each do |parameter|
+          merged_parameters.deep_merge!(parameter)
+        end
+        merged_parameters
+      end
+    end
+
     module ClassMethods
-      # Used to query data from the service.
-      def where(params = {})
-        data = request(params: params)
-        data._record.new(data)
+      def where(parameters = nil)
+        WhereChain.new(self, parameters)
       end
     end
   end

data/lib/lhs/record.rb

@@ -12,6 +12,7 @@ class LHS::Record
   include Mapping
   include Model
   include Includes
+  include Scope
   include Request
   include Where
   include Pagination

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "4.2.1"
+  VERSION = "5.0.0"
 end

data/spec/record/scope_chains_spec.rb

@@ -0,0 +1,37 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  let(:datastore) do
+    'http://datastore/v2'
+  end
+
+  let(:response) do
+    { body: [{ name: 'Steve' }] }
+  end
+
+  before(:each) do
+    LHC.config.placeholder('datastore', datastore)
+    class Record < LHS::Record
+      endpoint ':datastore/records/'
+      scope :blue, -> { where(color: 'blue') }
+      scope :available, -> { where(availalbe: 'true') }
+      scope :limited_to, ->(limit) { where(limit: limit) }
+    end
+  end
+
+  context 'scope chains' do
+    it 'allows chaining multiple scopes' do
+      stub_request(:get, "http://datastore/v2/records/?availalbe=true&color=blue&limit=20").to_return(response)
+      expect(
+        Record.blue.available.limited_to(20).first.name
+      ).to eq 'Steve'
+    end
+
+    it 'allows to chain multiple scopes when first one has arguments' do
+      stub_request(:get, "http://datastore/v2/records/?availalbe=true&color=blue&limit=20").to_return(response)
+      expect(
+        Record.limited_to(20).blue.available.first.name
+      ).to eq 'Steve'
+    end
+  end
+end

data/spec/record/where_chains_spec.rb

@@ -0,0 +1,55 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  let(:datastore) do
+    'http://datastore/v2'
+  end
+
+  let(:response) do
+    { body: [{ name: 'Steve' }] }
+  end
+
+  before(:each) do
+    LHC.config.placeholder('datastore', datastore)
+    class Record < LHS::Record
+      endpoint ':datastore/records/'
+
+      def uppercase_name
+        name.upcase
+      end
+    end
+  end
+
+  context 'where chains' do
+    before(:each) do
+      stub_request(:get, "http://datastore/v2/records/?available=true&color=blue&range=%3E26")
+        .to_return(response)
+    end
+
+    let(:records) { Record.where(color: 'blue').where(range: '>26').where(available: true) }
+
+    it 'allows chaining where statements' do
+      expect(records.class).to eq Record
+      expect(records._raw).to eq [{ name: 'Steve' }]
+      expect(records.first.uppercase_name).to eq 'STEVE'
+    end
+
+    it 'resolves triggered by method missing' do
+      expect(records._raw).to eq [{ name: 'Steve' }]
+      expect(
+        Record.where(color: 'blue').where(range: '>26', available: true).first.name
+      ).to eq 'Steve'
+    end
+  end
+
+  context 'multiple parameters' do
+    before(:each) do
+      stub_request(:get, "http://datastore/v2/records/?parameter=last").to_return(response)
+    end
+
+    it 'takes the last value for chains with same name parameters' do
+      records = Record.where(parameter: 'first').where(parameter: 'last')
+      records.first
+    end
+  end
+end

data/spec/record/where_values_hash_spec.rb

@@ -0,0 +1,30 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  let(:datastore) do
+    'http://datastore/v2'
+  end
+
+  let(:response) do
+    { body: [{ name: 'Steve' }] }
+  end
+
+  before(:each) do
+    LHC.config.placeholder('datastore', datastore)
+    class Record < LHS::Record
+      endpoint ':datastore/records/'
+    end
+  end
+
+  context 'where values hash' do
+    it 'provides the hash or where parameters that have been requested' do
+      stub_request(:get, "http://datastore/v2/records/?available=true&color=blue").to_return(response)
+      expect(
+        Record.where(available: true).where(color: 'blue').where_values_hash
+      ).to eq(available: true, color: 'blue')
+      expect(
+        Record.where(available: true, color: 'red').where(color: 'blue').where_values_hash
+      ).to eq(available: true, color: 'blue')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 5.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -197,6 +197,7 @@ files:
 - lib/lhs/concerns/record/model.rb
 - lib/lhs/concerns/record/pagination.rb
 - lib/lhs/concerns/record/request.rb
+- lib/lhs/concerns/record/scope.rb
 - lib/lhs/concerns/record/where.rb
 - lib/lhs/data.rb
 - lib/lhs/endpoint.rb
@@ -298,9 +299,12 @@ files:
 - spec/record/persisted_spec.rb
 - spec/record/request_spec.rb
 - spec/record/save_spec.rb
+- spec/record/scope_chains_spec.rb
 - spec/record/select_spec.rb
 - spec/record/to_json_spec.rb
+- spec/record/where_chains_spec.rb
 - spec/record/where_spec.rb
+- spec/record/where_values_hash_spec.rb
 - spec/spec_helper.rb
 - spec/support/cleanup_configuration.rb
 - spec/support/cleanup_endpoints.rb
@@ -330,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 1.9.2
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rails gem providing an easy, active-record-like interface for http json services
@@ -425,9 +429,12 @@ test_files:
 - spec/record/persisted_spec.rb
 - spec/record/request_spec.rb
 - spec/record/save_spec.rb
+- spec/record/scope_chains_spec.rb
 - spec/record/select_spec.rb
 - spec/record/to_json_spec.rb
+- spec/record/where_chains_spec.rb
 - spec/record/where_spec.rb
+- spec/record/where_values_hash_spec.rb
 - spec/spec_helper.rb
 - spec/support/cleanup_configuration.rb
 - spec/support/cleanup_endpoints.rb