lhs 19.8.2 → 19.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e57e3afbbffbdd6fdbcc8b64a947daae97b5faa5975ae8fe29b6b77d87b0d47
-  data.tar.gz: 5d8363f9dcbd226f60428e6344967ef2369639fd36544b7a6d9112d5058b8d31
+  metadata.gz: 5ae06289222aa01014699262ca1538093d7388f5e6a4fa689c3351d2fd6cf1d7
+  data.tar.gz: f0308f117f2f2dc44d0e0ada944c74ed0819b91198756fcedfeecebf472b0da9
 SHA512:
-  metadata.gz: 4f7ae19794cade9f046731c0c6cc948a87b8a04bada44e14c52853600b78c47f6ecfb53bc2bedbb16918cb0cf2788e3ac780873ebbeebbad544eb504494464aa
-  data.tar.gz: b8092ac44ed946248fa686e95873ce841cd1b38dbebbc41f7547037840b56e8c8c5d168c1866382e9f6e6eb51c181e43f407febe9d5ff1b476b1df3a063f326e
+  metadata.gz: 4778c1456b9f0aea0308f7a505d27641aa6a0bb1dc18170724c80542d182df8f5198f2e1a5de6db749722e22a59d1c1ea701934f8f89f365c05a4cc00af061c3
+  data.tar.gz: c64c7dece11ba95192669df9ea91d33a40262156eeac930efdfd8e432a4bfc51add6350746c937203309d67012499d15880c5b5b694ac66740556b9798dd8be6

data/README.md

@@ -2020,6 +2020,21 @@ With `includes` or `includes_all` (to enforce fetching all remote objects for pa
 
 Including linked resources/records is heavily influenced by [https://guides.rubyonrails.org/active_record_querying.html](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations) and you should read it to understand this feature in all it's glory.
 
+#### Generate links from parameters
+
+Sometimes you need to generate full hrefs/urls for records but you just have parameters that describe that record, like the ID.
+
+For those usecases you can use `href_for(params)`:
+
+```ruby
+# app/controllers/some_controller.rb
+
+Presence.create(place: { href: Place.href_for(123) })
+```
+```
+POST '/presences' { place: { href: "http://datastore/places/123" } }
+```
+
 #### Ensure the whole linked collection is included: includes_all
 
 In case endpoints are paginated and you are certain that you'll need all objects of a set and not only the first page/batch, use `includes_all`.

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+class LHS::Record
+
+  module HrefFor
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def href_for(args = nil)
+        return unless [Integer, String].include?(args.class)
+        params = { id: args }
+        find_endpoint(params).compile(params)
+      end
+      alias url_for href_for
+    end
+  end
+end

data/lib/lhs/record.rb

@@ -23,6 +23,8 @@ class LHS::Record
     'lhs/concerns/record/find_by'
   autoload :First,
     'lhs/concerns/record/first'
+  autoload :HrefFor,
+    'lhs/concerns/record/href_for'
   autoload :Last,
     'lhs/concerns/record/last'
   autoload :Mapping,
@@ -64,6 +66,7 @@ class LHS::Record
   include Find
   include FindBy
   include First
+  include HrefFor
   include LHS::IsHref
   include Last
   include LHS::Inspect

data/lib/lhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHS
-  VERSION = '19.8.2'
+  VERSION = '19.9.0'
 end

data/spec/record/href_for_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+  before do
+    class Record < LHS::Record
+      endpoint 'http://datastore/records/'
+      endpoint 'http://datastore/records/{id}'
+    end
+  end
+
+  context 'href_for' do
+
+    it 'injects variables and returns href' do
+      expect(Record.href_for(1)).to eq 'http://datastore/records/1'
+      expect(Record.href_for('vmasd241')).to eq 'http://datastore/records/vmasd241'
+    end
+
+    it 'also works with url_for (alias)' do
+      expect(Record.url_for(1)).to eq 'http://datastore/records/1'
+      expect(Record.url_for('vmasd241')).to eq 'http://datastore/records/vmasd241'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 19.8.2
+  version: 19.9.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2019-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -252,6 +252,7 @@ files:
 - lib/lhs/concerns/record/find.rb
 - lib/lhs/concerns/record/find_by.rb
 - lib/lhs/concerns/record/first.rb
+- lib/lhs/concerns/record/href_for.rb
 - lib/lhs/concerns/record/last.rb
 - lib/lhs/concerns/record/mapping.rb
 - lib/lhs/concerns/record/merge.rb
@@ -427,6 +428,7 @@ files:
 - spec/record/handle_includes_errors_spec.rb
 - spec/record/has_many_spec.rb
 - spec/record/has_one_spec.rb
+- spec/record/href_for_spec.rb
 - spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
 - spec/record/includes_all_spec.rb
@@ -639,6 +641,7 @@ test_files:
 - spec/record/handle_includes_errors_spec.rb
 - spec/record/has_many_spec.rb
 - spec/record/has_one_spec.rb
+- spec/record/href_for_spec.rb
 - spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
 - spec/record/includes_all_spec.rb