idy 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6349ce9069910d1380b20fc75f10ac110a18abb1
-  data.tar.gz: af38de63a88d7dd6ba36b8c872f9e195eea5f0fc
+  metadata.gz: f991a3fc046a1c984dd2ea37acf5f2881614ab7d
+  data.tar.gz: 437136e2d1abb67b41d882cfbb60ec4c579dd6ec
 SHA512:
-  metadata.gz: 44256a6ec3fd85dfbac624cbd9c25ab87963e737db3fc503a7dfd1b446fb6aa035c7cad59c64954159de273d6ad154e9cadfa5902779b7b0e3cb2951efb6cbd9
-  data.tar.gz: f774c785912c30529bea0961ed8e347f8002da7f63c3547cce19d5c1ff651c2757ac33e3a3cad9249d74c5587198fc9ae7d6a3529a1d15bb547765f7778b83d1
+  metadata.gz: a93e16c6d3ebdeaff9b27e5e264995d62cca1ba0301a80bbbc66faa080514aaf7b67df46bbaa429ecf6e11aca237e09d439adc1265b42a55efd53b958e0b7c87
+  data.tar.gz: f820c5618fe37624fe239d4b18c277acda0cd0db54114aad24e7ba6cfc09633861f6d6b83e82c1dd700accb76e75ca8aee937d1279c5d855d8f9f6e08d65538f

data/CHANGELOG.md

@@ -1,17 +1,22 @@
-## v0.1.2
+## v0.1.3
 
-#### Fix
+- features
+  - Added `find` method to find directly via idy returning `nil` when record is not found;
+  - Added `find!` method to find directly via idy raising error when record is not found.
 
-- set options on a prefixed var to avoid conflict.
+- bug fixes
+  - String that is integer like is not passed to original find method.
 
-## v0.1.1
+## v0.1.2
 
-#### Fix
+- bug fixes
+  - Set options on a prefixed var to avoid conflict.
 
-- v0.1.0 had problem on `push`.
+## v0.1.1
 
-## v0.1.0
+- bug fixes
+  - v0.1.0 had problem on `push`.
 
-#### Feature
+## v0.1.0
 
 - First release.

data/README.md

@@ -97,6 +97,34 @@ Article.find('My').id
 Keep in mind that if you have some internal code, that you cannot change,
 using `find`, the hash version of the id, `idy`, will be mandatory to correct find the record.
 
+## Findy and Findy!
+
+We encourage you to use this methods and avoid tweak `find` Rails method. As you expect, it will find directly via idy, so a normal integer will be not found, even if it exists on database.
+
+### Findy
+
+The bumpless version returns `nil` when record is not found.
+
+```ruby
+Article.findy('My').id
+# 1
+
+Article.findy 'missing'
+# nil
+```
+
+### Findy!
+
+The bump `!` version raises an error when record is not found.
+
+```ruby
+Article.findy!('My').id
+# 1
+
+Article.findy! 'missing'
+# ActiveRecord::RecordNotFound: Couldn't find Article with 'idy'="missing"
+```
+
 ## Inspiration
 
 It was inpired and improved from:

data/lib/idy/extension.rb

@@ -22,17 +22,27 @@ module Idy
 
     module ClassMethods
       def find(*args)
-        query = [args.first].flatten
-
-        if try(:idy?)
-          if query.size == 1
-            super idy_decode(query[0].to_s) || query[0]
-          else
-            super [query].flatten.map { |hash| idy_decode hash }
-          end
-        else
-          super [query].flatten.size == 1 ? query[0] : query
-        end
+        id = args.first
+
+        return super if args.count != 1 || integer?(id)
+
+        scope = try(:idy?) ? [id].flatten.map { |id| idy_decode(id) } : id
+
+        not_found!(id) if scope.compact.blank?
+
+        super scope.size == 1 ? scope[0] : scope
+      end
+
+      def findy(hash)
+        find_by id: idy_decode(hash)
+      end
+
+      def findy!(hash)
+        record = find_by(id: idy_decode(hash))
+
+        not_found!(hash) if record.nil?
+
+        record
       end
 
       def idy(options = {})
@@ -74,6 +84,16 @@ module Idy
       def encoder(salt)
         Hashids.new salt.to_s
       end
+
+      def integer?(id)
+        Integer id
+      rescue
+        false
+      end
+
+      def not_found!(hash)
+        raise ActiveRecord::RecordNotFound, "Couldn't find User with 'idy'=#{hash.inspect}"
+      end
     end
   end
 end

data/lib/idy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Idy
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

data/spec/lib/idy/extension/find_spec.rb

@@ -3,70 +3,83 @@
 require 'rails_helper'
 
 RSpec.describe Article do
-  context 'on reload' do
-    subject { described_class.create id: 42, title: 'title' }
+  context 'with idy enabled' do
+    context 'on reload' do
+      subject { described_class.create id: 42, title: 'title' }
 
-    it 'reloads' do
-      record = described_class.find(subject.to_param)
+      it 'reloads' do
+        record = described_class.find(subject.to_param)
 
-      record.update_attribute :title, 'title.updated'
+        record.update_attribute :title, 'title.updated'
 
-      expect(subject.title).to        eq 'title'
-      expect(subject.reload.title).to eq 'title.updated'
-    end
+        expect(subject.title).to        eq 'title'
+        expect(subject.reload.title).to eq 'title.updated'
+      end
 
-    context 'while locking' do
-      it 'does not throw an error' do
-        expect(-> { subject.lock! }).not_to raise_error
+      context 'while locking' do
+        it 'does not throw an error' do
+          expect(-> { subject.lock! }).not_to raise_error
+        end
       end
     end
-  end
 
-  context 'finding one record as id' do
-    subject { described_class.find record.id }
+    context 'finding one record as id' do
+      subject { described_class.find record.id }
 
-    let!(:record) { described_class.create id: 42, title: 'title-1' }
+      let!(:record) { described_class.create id: 42, title: 'title-1' }
 
-    specify { expect(subject).to eq record }
-  end
+      specify { expect(subject).to eq record }
+    end
 
-  context 'finding one record as idy' do
-    subject { described_class.find record.to_param }
+    context 'finding one record as idy' do
+      subject { described_class.find record.to_param }
 
-    let!(:record) { described_class.create id: 42, title: 'title-1' }
+      let!(:record) { described_class.create id: 42, title: 'title-1' }
 
-    specify { expect(subject).to eq record }
-  end
+      specify { expect(subject).to eq record }
+    end
 
-  context 'finding multiple records' do
-    subject { described_class.find [record_1.to_param, record_2.to_param] }
+    context 'finding multiple records' do
+      subject { described_class.find [record_1.to_param, record_2.to_param] }
 
-    let!(:record_1) { described_class.create id: 42, title: 'title-1' }
-    let!(:record_2) { described_class.create id: 1 , title: 'title-2' }
+      let!(:record_1) { described_class.create id: 42, title: 'title-1' }
+      let!(:record_2) { described_class.create id: 1 , title: 'title-2' }
 
-    it 'finds all' do
-      expect(subject).to eq [record_1, record_2]
+      it 'finds all' do
+        expect(subject).to eq [record_1, record_2]
+      end
+    end
+
+    context 'finding via has_many' do
+      let!(:article) { described_class.create }
+      let!(:comment) { Comment.create article: article }
+
+      specify { expect(article.comments.find(comment.id)).to eq comment }
     end
-  end
 
-  context 'finding via has_many' do
-    let!(:article) { described_class.create }
-    let!(:comment) { Comment.create article: article }
+    context 'when id is an integer like' do
+      let!(:record) { described_class.create id: 1 }
+      let!(:idy)    { '1a' }
 
-    specify { expect(article.comments.find(comment.id)).to eq comment }
+      it 'does not tries to use the integer part on normal find' do
+        expect { described_class.find(idy) }.to raise_error ActiveRecord::RecordNotFound, %(Couldn't find User with 'idy'="1a")
+      end
+    end
   end
 
-  context 'finding a class with no callback declared' do
+  context 'with idy disabled' do
     let!(:record) { Clean.create }
 
     context 'of one record' do
-      specify { expect(Clean.find(record.id)).to eq record }
+      it 'finds by normal id' do
+        expect(Clean.find(record.id)).to eq record
+      end
     end
 
     context 'of multiple record' do
       let!(:record_2) { Clean.create }
 
-      specify do
+      it 'finds by normal id' do
         expect(Clean.find([record.id, record_2.id])).to eq [record, record_2]
       end
     end

data/spec/lib/idy/extension/findy_bump_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe '#findy!' do
+  context 'when a hash is given' do
+    context 'and record is found' do
+      let!(:record) { Article.create id: 1 }
+      let!(:hash)   { 'My' }
+
+      it 'finds the record' do
+        expect(Article.findy!(hash)).to eq record
+      end
+    end
+
+    context 'and record is not found' do
+      let!(:hash) { 'My' }
+
+      it 'raises' do
+        expect { Article.findy!(hash) }.to raise_error ActiveRecord::RecordNotFound, %(Couldn't find User with 'idy'="My")
+      end
+    end
+  end
+end

data/spec/lib/idy/extension/findy_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe '#findy' do
+  context 'when a hash is given' do
+    context 'and record is found' do
+      let!(:record) { Article.create id: 1 }
+      let!(:hash)   { 'My' }
+
+      it 'finds the record' do
+        expect(Article.findy(hash)).to eq record
+      end
+    end
+
+    context 'and record is not found' do
+      let!(:hash) { 'My' }
+
+      it 'returns nil' do
+        expect(Article.findy(hash)).to be_nil
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idy
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Washington Botelho
@@ -156,6 +156,8 @@ files:
 - lib/idy/version.rb
 - spec/lib/idy/extension/find_by_spec.rb
 - spec/lib/idy/extension/find_spec.rb
+- spec/lib/idy/extension/findy_bump_spec.rb
+- spec/lib/idy/extension/findy_spec.rb
 - spec/lib/idy/extension/idy_decode_spec.rb
 - spec/lib/idy/extension/idy_default_salt_spec.rb
 - spec/lib/idy/extension/idy_encode_spec.rb
@@ -202,6 +204,8 @@ summary: An ID obfuscator for ActiveRecord.
 test_files:
 - spec/lib/idy/extension/find_by_spec.rb
 - spec/lib/idy/extension/find_spec.rb
+- spec/lib/idy/extension/findy_bump_spec.rb
+- spec/lib/idy/extension/findy_spec.rb
 - spec/lib/idy/extension/idy_decode_spec.rb
 - spec/lib/idy/extension/idy_default_salt_spec.rb
 - spec/lib/idy/extension/idy_encode_spec.rb