visibilize 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84568a8140b7e27087461d5707673a258efad3d5dc8fdd5305eca9516398f8a3
+  data.tar.gz: 902201dd9774ab0f5e0b971f3125a4b9840193bff28cf0bacfa77fd618b7fa8d
+SHA512:
+  metadata.gz: 4ddf68adcb0fa813ed29ed03553b8dd8cdb04cd369cc860d67ac33432c3003b236e0c24d89645a5b08599a613a533dfb773ba0240348118f38e1d9e0f57f1732
+  data.tar.gz: 1ca2048a188fa08798e2e637bb29b5a82d81be4f80fe50da3050e7284d3b76cf90cfd288aea4f898cfba5624513045a5174005cac0780fa20bc4d50aa7e964b0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at feapaydin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in visibilize.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    visibilize (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.3)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    mysql2 (0.5.3)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    yaml (0.1.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.0)
+  bundler (~> 2.0)
+  mysql2 (~> 0.5.3)
+  rake (~> 12.3.3)
+  rspec (~> 3.0)
+  visibilize!
+  yaml (~> 0.1.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Furkan Enes Apaydın
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,193 @@
+
+
+# Visibilize
+
+  
+
+Visibilize is a gem that automatically creates *friendly visible ID's* for *ActiveRecord* instances.
+
+
+Whenever you need an ID that **can be exposed** to end-users or a custom identifier for your models, visibilize can help.
+
+It:
+ - Can generate random `strings and integers` with `custom length` as identifier
+ - Can generate identifiers from `SecureRandom` methods like `uuid`, `hex` or `base64` 
+ - Can be triggered from different `ActiveRecord callbacks` to suit your needs  
+ - Can make the identifiers `unique` for each record
+ - Can create identifiers from provided `lambda` methods
+
+  
+
+## Installation
+
+  
+
+Add this line to your application's Gemfile:  
+
+```ruby
+
+gem  'visibilize'
+
+```
+
+  
+
+And then execute:
+
+  
+```
+$ bundle
+```
+  
+
+Or install it yourself as:
+
+  
+```
+$ gem install visibilize
+```
+  
+
+## Usage
+
+### Creating Attribute
+First you need to create an identifier column (attribute) for your ActiveRecord model, if not already exists.
+
+Run the command to create a migration:
+
+```
+rails g migration AddVisibleIdToUsers visible_id
+```
+You can name the column however you like. 
+You should also set the column type according to format of the identifier. You can make it an integer if you want your visible id to be numeric, otherwise string should work for most cases.
+
+Then run `rails db:migrate` to execute the migration. This will create the visible_id column in your table.
+
+---
+
+### Editing the Model
+After the database is ready, open the `app/models/user.rb` file and call `visibilize` 
+
+```ruby
+class User < ActiveRecord::Base
+  visibilize
+end
+```
+That's it.
+Whenever a record is being created it will fill the visible_id column with random unique integers automatically. 
+
+You can retrieve records with usual ActiveRecord calls:
+```ruby
+User.find_by_visible_id(params[:id])
+User.where(visible_id: params[:id]).first
+User.find_by(visible_id: params[:id])
+```
+
+---
+### Options
+Visibilize can be customized with provided options:
+```ruby
+class User < ActiveRecord::Base
+  visibilize  column:   :serial_number, # The column that will be used to store idenitifer
+              type:     :string, 	# Type/format of the created identifier
+              callback: :before_create, # ActiveRecord callback that ID will be created
+              length:   50,
+              unique:   true  
+end
+```
+
+
+#### Type
+Visibilize has its own generators for string and integer types. You can provide either `:string` or `:integer` as type. Bear in mind that random strings can also contain numbers inside them.
+
+Both string and integer values are being generated with respect to length option.
+
+The type also supports `SecureRandom` methods. For example:
+```ruby
+class User < ActiveRecord::Base
+  # The value will be generated from SecureRandom.uuid
+  # For more info about SecureRandom visit: https://apidock.com/ruby/SecureRandom
+  visibilize type: :uuid
+end
+```  
+The default type is `:integer`.
+
+#### Length
+The length specifies the length of the created string or integer. The `default length is 8`.
+
+If you are calling a SecureRandom method with type, the length will be sent as an argument to that method (if expected).
+Note that some SecureRandom methods does not use length parameter (like UUID, has fixed length 36)  so visibilize option for length will be unnecessary.
+
+
+#### Unique
+It simply specifies whether the provided value must be non existent in previous records of the model.
+By default this is set to `true`.
+The uniqueness will be checked with a loop in plain ruby, not on the database.
+```
+! CAUTION !
+If you're expecting the values to be unique, 
+you must consider the type and length of the generated identifier.
+The next available ID must be easy to find, 
+otherwise the loop can be iterate for too long 
+or even infinitely if no ID is available. 
+```
+
+
+#### Callback
+ActiveRecord supports multiple callbacks for different actions. You can provide the name of the callback that visibilize will be executed. The default callback is `before_create`.
+
+```ruby
+class User < ActiveRecord::Base
+  visibilize type:      :uuid,
+             callback:  :before_update
+end
+```  
+Note that visibilize **does not save** the record when it is called. You must save the generated value manually by calling `instance.save` whenever is fit, or use a callback that is just before the saving progress like `before_create`. 
+
+#### Lambda
+You can provide a lambda method to generate a value by custom conditions.
+If you provide a lambda, visibilize will automatically use it and skip its own generators.
+```ruby
+class User < ActiveRecord::Base
+  visibilize  column: :token,
+              lambda: ->() {return  Digest::MD5.hexdigest('foobar')}
+end
+```  
+Visibilize **cannot modify length** or **promise uniqueness** when using lambdas since the value will be generated from provided lambda method.
+
+## Bugs
+Please report any bugs by [creating issues on Github](https://github.com/FEApaydin/visibilize/issues).
+  
+  
+
+## Contribution
+
+### Setup
+The tests are using ActiveRecord `6.0` which requires ruby `2.5.0` or further. The recommended ruby version is `2.7.0`. Make sure you have the correct Ruby version.
+
+To install the gem requirements, run the command:
+
+```
+bin/setup
+```
+
+### Development
+All of the core files of the gem is under `lib/` directory. 
+You can develop your own generators inside `lib/visibilize/generator.rb` . 
+If you name your generator method in the `generate_md5` format, it will automatically be available to use with `type: :md5` option.
+
+### Testing
+Visibilize uses `rspec` for testing.
+Since the gem works on top of ActiveRecord, a database connection is required.
+Create a database and enter the credentials to `spec/db/database.yaml`. 
+Then run:
+```
+bundle exec rspec
+```  
+Rspec will automatically connect to the database, execute migrations for test tables and perform tests.
+It destroys all of the records from previous tests but does not truncate or drop the database.
+
+If somehow you cannot use migrations, there is a `spec/db/mysql.sql` file that contains plain SQL for creating the tables manually. 
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "visibilize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+
+# Do any other automated setup that you need to do here

data/lib/visibilize.rb

@@ -0,0 +1,35 @@
+require "visibilize/version"
+require "visibilize/generator"
+
+
+
+def visibilize(options={})
+
+  column    = options[:column]    || :visible_id
+  callback  = options[:callback]  || :before_create
+  type      = options[:type]      || :integer
+  unique    = options[:unique]    || true
+  length    = options[:length]    || 8
+  lamb      = options[:lambda]    || nil
+
+  # Define a method to fill the column with appropiate value
+  method_name="visibilize_#{column}"
+  define_method(method_name) do
+
+    raise "Visibilize Error: Attribute #{column} not found in #{self.class.name} instance." unless self.has_attribute?(column)
+
+    # Values are generated by VisibilizeGenerator class
+    value=lamb ? lamb.call : VisibilizeGenerator.get_value_for(type, self.class, column, length, unique)
+
+    write_attribute(column, value)
+  end
+
+  # Create a callback to execute method
+  callback=callback.to_s.split('_')
+  set_callback callback[1].to_sym, callback[0].to_sym, method_name.to_sym
+
+end
+# end visibilize
+
+
+

data/lib/visibilize/generator.rb

@@ -0,0 +1,72 @@
+require 'securerandom'
+
+module VisibilizeGenerator
+
+  class << self
+
+    def get_value_for(type, klass, column, length, unique)
+      method="generate_#{type}"
+      
+      
+      if self.respond_to?(method) 
+        from=:generators
+      elsif SecureRandom.respond_to?(type)
+        from=:securerandom
+      else
+        raise "Visibilize Error: No generator defined for type #{type}. (Asked for column #{column} of #{klass.name})" 
+      end
+
+      loop do
+        if from==:generators
+          generated=public_send(method, length)
+        elsif from==:securerandom
+          generated=generate_from_securerandom(type, length)
+        end
+
+        return generated if !unique || klass.where("#{column}='#{generated}'").empty?
+      end
+
+    end
+    # end get_value_for
+
+    
+    #
+    # Generators
+    #
+
+    def generate_integer(length)
+      return rand(1...10) if length==1
+
+      min=10**(length-1)  #1000
+      max=9*min + (min-1) #9999
+      rand(min...(max+1))
+    end
+
+    def generate_string(length)
+      available_chars=("a".."z").to_a + ("A".."Z").to_a + (0..9).to_a
+      
+      str=""
+      length.times do
+        str+=available_chars[rand(available_chars.size)].to_s 
+      end
+
+      str
+    end
+
+    def generate_from_securerandom(type, length)
+      if SecureRandom.respond_to?(type)  
+        begin
+          return SecureRandom.public_send(type, length)
+        rescue ArgumentError
+          return SecureRandom.public_send(type)
+        end
+      end
+      
+      return nil
+    end
+
+
+  end
+  # end static
+
+end

data/lib/visibilize/version.rb

@@ -0,0 +1,3 @@
+module Visibilize
+  VERSION = "0.1.1"
+end

data/visibilize.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "visibilize/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'visibilize'
+  spec.version       = Visibilize::VERSION
+  spec.authors       = ['Furkan Enes Apaydın']
+  spec.email         = ['feapaydin@gmail.com']
+
+  spec.summary       = %q{Generate random friendly identifiers for ActiveRecord instances.}
+  spec.description   = %q{Visibilize generates random friendly identifiers (visible_id) that can be exposed to end users for ActiveRecord models. }
+  spec.homepage      = 'https://github.com/FEApaydin/visibilize'
+  spec.license       = 'MIT'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/FEApaydin/visibilize'
+  spec.metadata["changelog_uri"] = 'https://github.com/FEApaydin/visibilize'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'activerecord', '~> 6.0'
+  spec.add_development_dependency 'mysql2', '~> 0.5.3'
+  spec.add_development_dependency 'yaml', '~> 0.1.0'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: visibilize
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Furkan Enes Apaydın
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: 'Visibilize generates random friendly identifiers (visible_id) that can
+  be exposed to end users for ActiveRecord models. '
+email:
+- feapaydin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/visibilize.rb
+- lib/visibilize/generator.rb
+- lib/visibilize/version.rb
+- visibilize.gemspec
+homepage: https://github.com/FEApaydin/visibilize
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/FEApaydin/visibilize
+  source_code_uri: https://github.com/FEApaydin/visibilize
+  changelog_uri: https://github.com/FEApaydin/visibilize
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Generate random friendly identifiers for ActiveRecord instances.
+test_files: []