idy 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48f9d830da49d857d4e7a933837f63a82be37a0bf8b79bb254ce9894e929c778
-  data.tar.gz: 7d564312480c2cd78a406669d90eb3e1b9a2f7a6a9d0675b131851c1aff1cfe0
+  metadata.gz: 5c1011342e7f8209b6c228fd8942f1d4e5b95032a2e30d541d0440c9edc9c9b8
+  data.tar.gz: a3033d0cc45ddde615174dc662e1c33f21e24a33739d1e4ae7b7cfa454a993d4
 SHA512:
-  metadata.gz: f20232384684b4aed106783643f6561ce92bc657430f24f15a34f8f0c38fe6ab7b706cbe5238bfa6e85636494470c0d78ab7c0e8635809eaaaab80508997d10b
-  data.tar.gz: 96ed2ff410876d03c33b74c6337df37e0a454d4a1602581384ce3d13ef0cb7a6ffc71ad4254f9498353e25c513bef612a5017fcf20905cce64fcf48f48cb7eb3
+  metadata.gz: e4972508e537e35f40bcc2126f738ffb31b1181e7d322d80375f1f7fce30dca31ca732130384017c22af25a7d1f74bcb0c344588adbaaffdd38ddd932910a1ea
+  data.tar.gz: b42199aa35fb78fb891e893ee3975964f1b02f84675ac0be0b7da6f9031732c8d1af5762fa8ab25d13b25070e9d22c1754da2e078285c42437465bc93e35e1dc

data/CHANGELOG.md

@@ -1,33 +1,52 @@
+## v1.2.0
+
+### Fixes
+
+- Allows namespaced class to be obfuscated. [#10](https://github.com/wbotelhos/idy/pull/10) by [vitobotta](https://github.com/vitobotta)
+
+### Updates
+
+- Adds all previous version on the [Releases page](https://github.com/wbotelhos/idy/releases);
+- Adds coverage via [Codecov](https://app.codecov.io/gh/wbotelhos/idy);
+- Moves the CI to [Github Actions](https://github.com/wbotelhos/idy/actions);
+- Removes spec files from the gem to keep the package smaller;
+
 ## v1.1.0
 
-- Updates
-  - Does not restrict Rails version;
-  - Does not restrict Hashids version;
-  - Bump Ruby version to 2.6.4;
+### Updates
+
+- Does not restrict Rails version;
+- Does not restrict Hashids version;
+- Bump Ruby version to 2.6.4;
 
 ## 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)
+### Break Changes
+
+- Drops `find` override method to avoid finding on a hash that looks like a number issue [#1](https://github.com/wbotelhos/idy/issues/1)
 
 ## v0.1.3
 
-- 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.
+### Features
+
+- Added `find` method to find directly via idy returning `nil` when the record is not found;
+- Added `find!` method to find directly via idy raising an error when the record is not found.
+
+### Fixes
 
-- bug fixes
-  - String that is integer like is not passed to original find method.
+- String that is integer-like is not passed to the original find method.
 
 ## v0.1.2
 
-- bug fixes
-  - Set options on a prefixed var to avoid conflict.
+### Fixes
+
+- Set options on a prefixed var to avoid conflict.
 
 ## v0.1.1
 
-- bug fixes
-  - v0.1.0 had problem on `push`.
+### Fixes
+
+- v0.1.0 had a problem with `push`.
 
 ## v0.1.0
 

data/README.md

@@ -1,7 +1,10 @@
 # Idy
 
-[![Build Status](https://travis-ci.org/wbotelhos/idy.svg)](https://travis-ci.org/wbotelhos/idy)
+[![CI](https://github.com/wbotelhos/idy/workflows/CI/badge.svg)](https://github.com/wbotelhos/idy/actions)
 [![Gem Version](https://badge.fury.io/rb/idy.svg)](https://badge.fury.io/rb/idy)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f312587b4f126bb13e85/maintainability)](https://codeclimate.com/github/wbotelhos/idy/maintainability)
+[![Coverage](https://codecov.io/gh/wbotelhos/idy/branch/main/graph/badge.svg)](https://codecov.io/gh/wbotelhos/idy)
+[![Sponsor](https://img.shields.io/badge/sponsor-%3C3-green)](https://www.patreon.com/wbotelhos)
 
 An ID obfuscator for ActiveRecord.
 
@@ -144,13 +147,31 @@ Article.findy! 'missing'
 # ActiveRecord::RecordNotFound: Couldn't find Article with 'idy'="missing"
 ```
 
+## Functions
+
+You can encode a number manually:
+
+```ruby
+Model.idy_encode(idy)
+```
+
+You can decode an idy in case you want to use the ActiveRecord methods with the original ID:
+
+```ruby
+Model.idy_decode(idy)
+```
+
+## Testing
+Check if your model responds to idy method:
+
+### RSpec
+```ruby
+it { is_expected.to respond_to(:idy) }
+```
+
 ## Inspiration
 
-It was inpired and improved from:
+It was inspired and improved from:
 
 - [obfuscate_id](https://github.com/namick/obfuscate_id)
 - [hashids_uri](https://github.com/danieldraper/hashids_uri)
-
-## Love it!
-
-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

@@ -46,7 +46,7 @@ module Idy
       def idy_default_salt
         alphabet = Array('a'..'z')
 
-        indexes = name.downcase.split('').map do |char|
+        indexes = name.downcase.tr(':', '').split('').map do |char|
           alphabet.index(char) + 1
         end
 

data/lib/idy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Idy
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idy
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Washington Botelho
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -126,7 +140,10 @@ description: An ID obfuscator for ActiveRecord.
 email: wbotelhos@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 files:
 - CHANGELOG.md
 - LICENSE
@@ -134,31 +151,11 @@ files:
 - lib/idy.rb
 - lib/idy/extension.rb
 - lib/idy/version.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/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/clean.rb
-- spec/support/models/comment.rb
-- spec/support/models/post.rb
-- spec/support/models/user.rb
 homepage: https://github.com/wbotelhos/idy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -173,28 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: An ID obfuscator for ActiveRecord.
-test_files:
-- spec/support/migrate.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
+test_files: []

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

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

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

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

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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Article, '#idy_decode' do
-  context 'with no given salt' do
-    it 'undos the obfuscation of id with default class salt' do
-      expect(described_class.idy_decode('My')).to eq 1
-    end
-  end
-
-  context 'with empty salt' do
-    let!(:salt) { '' }
-
-    it 'undos the obfuscation of id with given salt' do
-      expect(described_class.idy_decode('jR', salt: salt)).to eq 1
-    end
-  end
-
-  context 'with salt' do
-    context 'when is string' do
-      let!(:salt) { 'salt' }
-
-      it 'undos the obfuscation of id with given salt' do
-        expect(described_class.idy_decode('XG', salt: salt)).to eq 1
-      end
-    end
-
-    context 'when is number' do
-      let!(:salt) { 1 }
-
-      it 'undos the obfuscation of id with given salt as string' do
-        expect(described_class.idy_decode('kL', salt: 1)).to eq 1
-      end
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-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(described_class.idy_default_salt).to eq '12345678910'
-    end
-  end
-end

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Article, '#idy_encode' do
-  context 'with no given salt' do
-    let!(:model) { described_class.new id: 1 }
-
-    it 'obfuscates the id with default class salt' do
-      expect(model.class.idy_encode(model.id)).to eq 'My'
-    end
-  end
-
-  context 'with empty salt' do
-    let!(:model) { described_class.new id: 1 }
-    let!(:salt)  { '' }
-
-    it 'obfuscates the id with empty salt' do
-      expect(model.class.idy_encode(model.id, salt: salt)).to eq 'jR'
-    end
-  end
-
-  context 'with salt' do
-    let!(:model) { described_class.new id: 1 }
-
-    context 'when is string' do
-      let!(:salt) { 'salt' }
-
-      it 'obfuscates the id with given salt' do
-        expect(model.class.idy_encode(model.id, salt: salt)).to eq 'XG'
-      end
-    end
-
-    context 'when is number' do
-      let!(:salt) { 1 }
-
-      it 'obfuscates the id with given salt as string' do
-        expect(model.class.idy_encode(model.id, salt: salt)).to eq 'kL'
-      end
-    end
-  end
-
-  context 'with nil id' do
-    let!(:model) { described_class.new }
-
-    it 'returns nil' do
-      expect(model.class.idy_encode(model.id)).to be_nil
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Article, '.idy' do
-  subject { described_class.new id: 1 }
-
-  it 'returns the encoded id' do
-    expect(subject.idy).to eq 'My'
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-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(described_class.idy_options).to eq(salt: article_default_salt)
-    end
-  end
-
-  context 'when salt is given' do
-    it 'returns a default options with a salt equal the given one' do
-      expect(Comment.idy_options).to eq(salt: 'salt')
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Clean, ':salt' do
-  describe '#salt' do
-    before { allow(described_class).to receive(:idy_options).and_return(salt: :salty) }
-
-    it 'fetchs the salt options' do
-      expect(described_class.salt).to eq(:salty)
-    end
-  end
-
-  describe '.salt' do
-    before { allow(described_class).to receive(:salt).and_return :salt }
-
-    it 'delegates to class method' do
-      expect(described_class.new.salt).to eq :salt
-    end
-  end
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Clean, '.to_param' do
-  context 'when object does not acts as idy' do
-    subject { described_class.new id: 1 }
-
-    it 'behaves as default' do
-      expect(subject.to_param).to eq '1'
-    end
-  end
-
-  context 'when object acts as idy' do
-    context 'with no given salt' do
-      let!(:model_1) { Article.new id: 1 }
-
-      it 'generates a hash' do
-        expect(model_1.to_param).to eq 'My'
-      end
-
-      context 'with comparison' do
-        let!(:model_2) { Post.new }
-
-        context 'with other object with same id' do
-          before { model_2.id = 1 }
-
-          it 'generates different hash' do
-            expect(model_1.to_param).not_to eq model_2.to_param
-          end
-        end
-      end
-
-      context 'when object is not persisted' do
-        context 'when has no id' do
-          subject { Article.new }
-
-          specify { expect(subject.to_param).to be_nil }
-        end
-
-        context 'when has id' do
-          subject { Article.new id: 1 }
-
-          it 'generates a hash' do
-            expect(model_1.to_param).to eq 'My'
-          end
-        end
-      end
-    end
-  end
-end

data/spec/rails_helper.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-ENV['RAILS_ENV'] ||= 'test'
-
-require 'active_record/railtie'
-require 'idy'
-require 'pry-byebug'
-
-ActiveRecord::Base.establish_connection adapter: :sqlite3, database: ':memory:'
-
-Dir[File.expand_path('support/**/*.rb', __dir__)].each { |file| require file }
-
-def article_default_salt
-  '1182093125'
-end
-
-def clean_default_salt
-  '3125114'
-end
-
-def comment_default_salt
-  ''
-end
-
-def user_default_salt
-  '1182093125'
-end

data/spec/support/common.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'rspec/rails'
-
-RSpec.configure do |config|
-  config.filter_run_when_matching :focus
-
-  config.disable_monkey_patching!
-
-  config.order = :random
-end

data/spec/support/database_cleaner.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'database_cleaner'
-
-RSpec.configure do |config|
-  config.before :suite do
-    DatabaseCleaner.strategy = :transaction
-
-    DatabaseCleaner.clean_with :transaction
-  end
-
-  config.before do
-    DatabaseCleaner.start
-  end
-
-  config.around do |spec|
-    DatabaseCleaner.cleaning do
-      spec.run
-    end
-  end
-end

data/spec/support/db/migrate/create_tables.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-class CreateTables < ActiveRecord::Migration[5.0]
-  def change
-    create_table :abcdefghijklms do |t|
-    end
-
-    create_table :articles do |t|
-      t.string :title
-    end
-
-    create_table :cleans do |t|
-    end
-
-    create_table :comments do |t|
-      t.string :body
-
-      t.references :article, index: true, foreign_key: true
-    end
-
-    create_table :posts do |t|
-      t.string :title
-    end
-
-    create_table :users do |t|
-      t.string :name
-    end
-  end
-end

data/spec/support/migrate.rb

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

data/spec/support/models/abcdefghijklm.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class Abcdefghijklm < ActiveRecord::Base
-end

data/spec/support/models/article.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class Article < ::ActiveRecord::Base
-  idy
-
-  has_many :comments
-end

data/spec/support/models/clean.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class Clean < ::ActiveRecord::Base
-end

data/spec/support/models/comment.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class Comment < ::ActiveRecord::Base
-  idy salt: 'salt'
-
-  belongs_to :article
-end

data/spec/support/models/post.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-class Post < ::ActiveRecord::Base
-  idy
-end

data/spec/support/models/user.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class User < ::ActiveRecord::Base
-end