fantasy_identifiable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9057c9817d0effbe2c1ad66061eaf1f972c44b5b828d99e0daaf11ee51a48c84
+  data.tar.gz: 2ec4cf4407bcbfd845c45695c77c992c1e7b56c3ffcae5961fc7950fef0c198f
+SHA512:
+  metadata.gz: 942db56529c0f117552550da0e014640620fd935a1efd57d243e3ba2eae87b88d0007f80c4c6a4fc0b8247fd9ebc0885275b9eed91ea5d10649cd7a73af6a691
+  data.tar.gz: 2e9406ce0905156be7721a89f85007333b929793e8fac7c1ea55df97403c91147b5043786fb6e63472ace80ae91e4c82e7ff5cfe4f7dcad2db904e85e8533099

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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,99 @@
+# FantasyIdentifiable
+
+This gem allows you to create unique readable fantasy names as identifiers for your active record objects.
+
+You can also define multiple identifier columns and alternatively use a UUID or friendly_token as identifier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fantasy_identifiable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fantasy_identifiable
+
+## Usage
+
+Make sure your ActiveRecord Model has a string field that you want to use as an identifier.
+
+### Examples
+
+Here you can see the db schema and model definitions for multiple usage examples.
+
+**DB Schema:**
+
+```ruby
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :fantasy_objects, force: true do |t|
+    t.string :identifier
+  end
+
+  create_table :friendly_objects, force: true do |t|
+    t.string :identifier
+  end
+
+  create_table :uuid_objects, force: true do |t|
+    t.string :identifier
+  end
+
+  create_table :multi_objects, force: true do |t|
+    t.string :identifier
+    t.string :friendly_name
+  end
+end
+```
+
+**ActiveRecord Models**
+
+```ruby
+class FantasyObject < ActiveRecord::Base
+  include FantasyIdentifiable
+  identifiable({ identifier: :fantasy })
+end
+
+class FriendlyObject < ActiveRecord::Base
+  include FantasyIdentifiable
+  identifiable({ identifier: :friendly })
+end
+
+class UuidObject < ActiveRecord::Base
+  include FantasyIdentifiable
+  identifiable({ identifier: :uuid })
+end
+
+class MultiObject < ActiveRecord::Base
+  include FantasyIdentifiable
+  identifiable({
+    friendly_name: :friendly,
+    identifier: :uuid
+  })
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arusa/fantasy_identifiable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FantasyIdentifiable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/arusa/fantasy_identifiable/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/fantasy_identifiable.rb

@@ -0,0 +1,96 @@
+require "fantasy_identifiable/version"
+require "active_support/concern"
+require "faker"
+
+module FantasyIdentifiable
+  # class Error < StandardError; end
+
+  extend ::ActiveSupport::Concern
+
+  included do
+    # class << self; attr_reader :identifier_fields; end
+    before_create :generate_identifiers
+  end
+
+  def generate_identifiers
+    self.class.identifier_fields.each do |field_name, field_type|
+      case field_type
+      when :friendly
+        set_friendly_identifier field_name
+      when :fantasy
+        set_fantasy_identifier field_name
+      else
+        set_uuid_identifier field_name
+      end
+    end
+  end
+
+  class_methods do
+    attr_reader :identifier_fields
+
+    def identifiable(fields)
+      @identifier_fields = fields
+    end
+  end
+
+  def identifier_with(field_name, &block)
+    loop do
+      new_id = block.call
+      if self.class.where("#{field_name} LIKE ?", new_id).empty?
+        send("#{field_name}=", new_id)
+        break
+      end
+    end
+  end
+
+  def set_fantasy_identifier field_name
+    identifier_with(field_name) do
+      random_fantasy_identifier
+    end
+  end
+
+  def set_friendly_identifier field_name
+    identifier_with(field_name) do
+      friendly_token(20).downcase.tr("-_", "ab")
+    end
+  end
+
+  def set_uuid_identifier field_name
+    identifier_with(field_name) do
+      SecureRandom.uuid
+    end
+  end
+
+  def friendly_token(length = 20)
+    # To calculate real characters, we must perform this operation.
+    # See SecureRandom.urlsafe_base64
+    rlength = (length * 3) / 4
+    SecureRandom.urlsafe_base64(rlength).tr('lIO0', 'sxyz')
+  end
+
+  def random_fantasy_identifier
+    (
+      (
+        Faker::Hipster.words(number: 4) +
+        [
+          Faker::TvShows::Stargate.planet,
+          Faker::TvShows::GameOfThrones.city,
+          Faker::TvShows::GameOfThrones.dragon,
+          Faker::Movies::HitchhikersGuideToTheGalaxy.planet,
+          Faker::Creature::Animal.name,
+          Faker::Creature::Cat.name,
+          Faker::Creature::Dog.name,
+          Faker::Fantasy::Tolkien.race,
+          Faker::Books::Dune.city,
+          Faker::Books::Dune.planet,
+          Faker::Verb.past,
+          Faker::Science.element,
+          Faker::Name.first_name,
+          Faker::Job.key_skill,
+          Faker::Hacker.noun
+        ]
+      ).sample(3) +
+      [friendly_token(3).downcase.tr("-_", "ab")]
+    ).join("-").delete(" ").downcase
+  end
+end

data/lib/fantasy_identifiable/version.rb

@@ -0,0 +1,3 @@
+module FantasyIdentifiable
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: fantasy_identifiable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Rusa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: This gem allows you to create unique readable fantasy names as identifiers
+  for your active record objects. You can also define multiple identifier columns
+  and alternatively use a UUID or Devise.friendly_token as identifier.
+email:
+- alex@rusa.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/fantasy_identifiable.rb
+- lib/fantasy_identifiable/version.rb
+homepage: https://github.com/arusa/fantasy_identifiable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/arusa/fantasy_identifiable
+  source_code_uri: https://github.com/arusa/fantasy_identifiable
+  changelog_uri: https://github.com/arusa/fantasy_identifiable/blob/master/CHANGELOG.md
+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.4
+signing_key:
+specification_version: 4
+summary: Create unique fantasy names as identifier for your activerecord objects
+test_files: []