idy 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f991a3fc046a1c984dd2ea37acf5f2881614ab7d
-  data.tar.gz: 437136e2d1abb67b41d882cfbb60ec4c579dd6ec
+SHA256:
+  metadata.gz: def5f180e468e7b690506b0c44629f0f8ee2f1f8c43faef0c3da2dd4d84bca7c
+  data.tar.gz: a75a3403bb5564350d46db9655f9f4acec21d3f7079820a60442a9e0cfc8ec10
 SHA512:
-  metadata.gz: a93e16c6d3ebdeaff9b27e5e264995d62cca1ba0301a80bbbc66faa080514aaf7b67df46bbaa429ecf6e11aca237e09d439adc1265b42a55efd53b958e0b7c87
-  data.tar.gz: f820c5618fe37624fe239d4b18c277acda0cd0db54114aad24e7ba6cfc09633861f6d6b83e82c1dd700accb76e75ca8aee937d1279c5d855d8f9f6e08d65538f
+  metadata.gz: 86b8b4eaddbc6acc12c7c5a9ee72c31d884a2835d66a0bbff5a1c90ab0a473ebf50f42a5fec0802c9bcd675f19a3ef028ec68ba0938554e3dcdf945360f9bc66
+  data.tar.gz: 539a92ad5de1baf061e736250e12978bc4c1dc2f24f0aa36c1b0cdea61440eec75b75e2958f1b49b6600df277337e9b6749c75fb27e089bd1a1f5842437ae96f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v1.0.0
+
+- News
+ - Drops overrided `find` method to avoid find on a hash that looks like a number issue [#1](https://github.com/wbotelhos/idy/issues/1)
+
 ## v0.1.3
 
 - features

data/README.md

@@ -45,7 +45,7 @@ Article.new(id: 1).idy
 # My
 ```
 
-It will build you Rals URL with that ID too:
+It will build your Rails URL with that ID too:
 
 ```ruby
 Article.new(id: 1).to_param
@@ -60,7 +60,7 @@ If you want a *unbreakable* hash, it is not for you.
 ## Collision
 
 To avoid two differents models to generates the same hash for the same ID,
-by default, the class name is used as a [Salt](https://en.wikipedia.org/wiki/Salt_(cryptography).
+by default, the class name is used as a [Salt](https://en.wikipedia.org/wiki/Salt_cryptography).
 
 ```ruby
 Article.new(id: 1).idy
@@ -85,6 +85,25 @@ Article.new(id: 1).idy
 # 9A
 ```
 
+## Idy
+
+As you could see, the method `idy`, returns the hash representation of your ID:
+
+```ruby
+Article.new(id: 1).idy
+# My
+```
+
+If you want get all idys from a collection, just map it:
+
+```ruby
+Article.create
+Article.create
+
+Article.select(:id).map(&:idy)
+# ["My", "aL"]
+```
+
 ## Find
 
 Since you add the `idy` callback to your model, `find` method will be decorated:
@@ -134,4 +153,4 @@ It was inpired and improved from:
 
 ## Love it!
 
-Via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=idy) or [Gratipay](https://gratipay.com/~wbotelhos). Thanks! (:
+Via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=idy) or [Gratipay](https://liberapay.com/idy/donate). Thanks! (:

data/lib/idy/extension.rb

@@ -21,18 +21,6 @@ module Idy
     end
 
     module ClassMethods
-      def find(*args)
-        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
@@ -85,12 +73,6 @@ module Idy
         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

data/lib/idy/version.rb

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

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

@@ -2,9 +2,9 @@
 
 require 'rails_helper'
 
-RSpec.describe '#findy!' do
+RSpec.describe Article, '#findy!' do
   context 'when a hash is given' do
-    context 'and record is found' do
+    context 'when record is found' do
       let!(:record) { Article.create id: 1 }
       let!(:hash)   { 'My' }
 
@@ -13,11 +13,13 @@ RSpec.describe '#findy!' do
       end
     end
 
-    context 'and record is not found' do
+    context 'when 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")
+        message = %(Couldn't find User with 'idy'="My")
+
+        expect { Article.findy!(hash) }.to raise_error ActiveRecord::RecordNotFound, message
       end
     end
   end

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

@@ -2,9 +2,9 @@
 
 require 'rails_helper'
 
-RSpec.describe '#findy' do
+RSpec.describe Article, '#findy' do
   context 'when a hash is given' do
-    context 'and record is found' do
+    context 'when record is found' do
       let!(:record) { Article.create id: 1 }
       let!(:hash)   { 'My' }
 
@@ -13,7 +13,7 @@ RSpec.describe '#findy' do
       end
     end
 
-    context 'and record is not found' do
+    context 'when record is not found' do
       let!(:hash) { 'My' }
 
       it 'returns nil' do

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

@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-RSpec.describe '#idy_decode' do
+RSpec.describe Article, '#idy_decode' do
   context 'with no given salt' do
     it 'undos the obfuscation of id with default class salt' do
       expect(Article.idy_decode('My')).to eq 1
@@ -18,7 +18,7 @@ RSpec.describe '#idy_decode' do
   end
 
   context 'with salt' do
-    context 'as string' do
+    context 'when is string' do
       let!(:salt) { 'salt' }
 
       it 'undos the obfuscation of id with given salt' do
@@ -26,7 +26,7 @@ RSpec.describe '#idy_decode' do
       end
     end
 
-    context 'as number' do
+    context 'when is number' do
       let!(:salt) { 1 }
 
       it 'undos the obfuscation of id with given salt as string' do

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

@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-RSpec.describe '#idy_default_salt' do
+RSpec.describe Abcdefghijklm, '#idy_default_salt' do
   context 'when class name has a big length' do
     it 'is bases on the first 10 class letter position index on alphabet' do
       expect(Abcdefghijklm.idy_default_salt).to eq '12345678910'

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

@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-RSpec.describe '#idy_encode' do
+RSpec.describe Article, '#idy_encode' do
   context 'with no given salt' do
     let!(:model) { Article.new id: 1 }
 
@@ -23,7 +23,7 @@ RSpec.describe '#idy_encode' do
   context 'with salt' do
     let!(:model) { Article.new id: 1 }
 
-    context 'as string' do
+    context 'when is string' do
       let!(:salt) { 'salt' }
 
       it 'obfuscates the id with given salt' do
@@ -31,7 +31,7 @@ RSpec.describe '#idy_encode' do
       end
     end
 
-    context 'as number' do
+    context 'when is number' do
       let!(:salt) { 1 }
 
       it 'obfuscates the id with given salt as string' do

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

@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-RSpec.describe '.idy' do
+RSpec.describe Article, '.idy' do
   subject { Article.new id: 1 }
 
   it 'returns the encoded id' do

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

@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-RSpec.describe '.idy_options' do
+RSpec.describe Article, '.idy_options' do
   context 'when options is not given' do
     it 'returns a default options with a salt generated based on model name' do
       expect(Article.idy_options).to eq(salt: article_default_salt)

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

@@ -2,11 +2,9 @@
 
 require 'rails_helper'
 
-RSpec.describe ':salt' do
+RSpec.describe Clean, ':salt' do
   describe '#salt' do
-    before do
-      allow(Clean).to receive(:idy_options) { { salt: :salty } }
-    end
+    before { allow(Clean).to receive(:idy_options).and_return(salt: :salty) }
 
     it 'fetchs the salt options' do
       expect(Clean.salt).to eq(:salty)
@@ -14,7 +12,7 @@ RSpec.describe ':salt' do
   end
 
   describe '.salt' do
-    before { allow(Clean).to receive(:salt) { :salt } }
+    before { allow(Clean).to receive(:salt).and_return :salt }
 
     it 'delegates to class method' do
       expect(Clean.new.salt).to eq :salt

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

@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-RSpec.describe '.to_param' do
+RSpec.describe Clean, '.to_param' do
   context 'when object does not acts as idy' do
     subject { Clean.new id: 1 }
 
@@ -32,13 +32,13 @@ RSpec.describe '.to_param' do
       end
 
       context 'when object is not persisted' do
-        context 'and has no id' do
+        context 'when has no id' do
           subject { Article.new }
 
           specify { expect(subject.to_param).to be_nil }
         end
 
-        context 'and has id' do
+        context 'when has id' do
           subject { Article.new id: 1 }
 
           it 'generates a hash' do

data/spec/support/database_cleaner.rb

@@ -9,7 +9,7 @@ RSpec.configure do |config|
     DatabaseCleaner.clean_with :transaction
   end
 
-  config.before :each do
+  config.before do
     DatabaseCleaner.start
   end
 

data/spec/support/migrate.rb

@@ -1,3 +1,5 @@
 # frozen_string_literal: true
 
+require 'support/db/migrate/create_tables'
+
 CreateTables.new.change

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idy
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Washington Botelho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-06 00:00:00.000000000 Z
+date: 2017-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashids
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,20 +86,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +101,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,7 +115,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -154,15 +140,12 @@ files:
 - lib/idy.rb
 - lib/idy/extension.rb
 - 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
 - spec/lib/idy/extension/idy_spec.rb
-- spec/lib/idy/extension/lock_spec.rb
 - spec/lib/idy/extension/options_spec.rb
 - spec/lib/idy/extension/salt_spec.rb
 - spec/lib/idy/extension/to_param_spec.rb
@@ -197,31 +180,28 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 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
-- spec/lib/idy/extension/idy_spec.rb
-- spec/lib/idy/extension/lock_spec.rb
-- spec/lib/idy/extension/options_spec.rb
-- spec/lib/idy/extension/salt_spec.rb
-- spec/lib/idy/extension/to_param_spec.rb
-- spec/rails_helper.rb
-- spec/support/common.rb
-- spec/support/database_cleaner.rb
-- spec/support/db/migrate/create_tables.rb
 - spec/support/migrate.rb
-- spec/support/models/abcdefghijklm.rb
 - spec/support/models/article.rb
+- spec/support/models/abcdefghijklm.rb
 - spec/support/models/clean.rb
 - spec/support/models/comment.rb
 - spec/support/models/post.rb
 - spec/support/models/user.rb
+- spec/support/common.rb
+- spec/support/db/migrate/create_tables.rb
+- spec/support/database_cleaner.rb
+- spec/lib/idy/extension/idy_spec.rb
+- spec/lib/idy/extension/to_param_spec.rb
+- spec/lib/idy/extension/salt_spec.rb
+- spec/lib/idy/extension/options_spec.rb
+- spec/lib/idy/extension/idy_encode_spec.rb
+- spec/lib/idy/extension/idy_decode_spec.rb
+- spec/lib/idy/extension/findy_spec.rb
+- spec/lib/idy/extension/findy_bump_spec.rb
+- spec/lib/idy/extension/idy_default_salt_spec.rb
+- spec/rails_helper.rb

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Article, '.find_by' do
-  subject { described_class.create title: 'title' }
-
-  it 'works with normal id' do
-    record = described_class.find_by(id: subject.id)
-
-    expect(subject).to eq record
-  end
-end

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

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Article do
-  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)
-
-        record.update_attribute :title, 'title.updated'
-
-        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
-        end
-      end
-    end
-
-    context 'finding one record as id' do
-      subject { described_class.find record.id }
-
-      let!(:record) { described_class.create id: 42, title: 'title-1' }
-
-      specify { expect(subject).to eq record }
-    end
-
-    context 'finding one record as idy' do
-      subject { described_class.find record.to_param }
-
-      let!(:record) { described_class.create id: 42, title: 'title-1' }
-
-      specify { expect(subject).to eq record }
-    end
-
-    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' }
-
-      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
-
-    context 'when id is an integer like' do
-      let!(:record) { described_class.create id: 1 }
-      let!(:idy)    { '1a' }
-
-      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 'with idy disabled' do
-    let!(:record) { Clean.create }
-
-    context 'of one record' do
-      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 }
-
-      it 'finds by normal id' do
-        expect(Clean.find([record.id, record_2.id])).to eq [record, record_2]
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Article, '.lock!' do
-  subject { described_class.create title: 'title' }
-
-  it 'works' do
-    record = described_class.find(subject.to_param)
-
-    expect { record.lock! }.not_to raise_error
-  end
-end