uidable 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f28135965e6d202b5b1bed1cba057d98c38c9c4
+  data.tar.gz: 22045616ed69d00b46ad8aa92bbd2c18164dfeeb
+SHA512:
+  metadata.gz: fa5a9acc323073795f704b5c808dddf9500e3bb617e822a153c93cceda2806a30d38fe252a0c404adbc4ed0a03857d67e0b77bdb3eee4653f0864ad80c8ce357
+  data.tar.gz: 2786c31ff3cf9cfe7319eb569770ff7203a17882b2bee37598e82e67b83872fc178d04dfac2abc2ad1cd3de7f5a54ca5b0790afb92ac31360f57c216e4c07fd7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'minitest'
+  gem 'activerecord'
+  gem 'sqlite3', platform: [:ruby, :mswin, :mingw]
+  gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sibevin Wang
+
+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,138 @@
+# Uidable
+
+Create the uid(unqiue identifier) attribute in your model or class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uidable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uidable
+
+## Usage
+
+### ActiveRecord
+
+1. Create a migration to add the uid column in your table.
+2. Include uidable in your model.
+3. Setup uidable with/without options in your model.
+4. Uid is generated and ready to use when a record is created. Note that the uid is still nil when the record is initialized but haven't be saved.
+
+A migration example:
+
+    class AddUidToMyModels < ActiveRecord::Migration
+      def change
+        add_column :my_models, :uid, :string, null: false
+        add_index :my_models, :uid, unique: true
+      end
+    end
+
+A model example:
+
+    class MyModel
+      include Uidable
+      uidable
+    end
+
+    a = MyClass.new
+    a.uid # nil
+    a.save
+    a.uid "cmerft8rotdy7wvmtxc63ljoxos67bc8"
+
+### Ruby Class
+
+1. Include uidable in your class.
+2. Setup uidable with/without options in your class.
+3. Uid is generated and ready to use when an instance is initialized.
+
+A class example:
+
+    class MyClass
+      include Uidable
+      uidable uid_size: 64, read_only: false
+    end
+
+    a = MyClass.new
+    a.uid # "zcf45ltmkyh4w2ofsc1rp8dka6wi4flt3h3szwo1z4rkfsvk387mclg1cikutbc7"
+
+Please reference tests for more usage examples.
+
+## Options
+
+### Uid Name
+
+The default uid attribute is named with "uid", you can change it with `uid_name: <name>`. Note that you need change the column name in your migration as well.
+
+### Uid Size
+
+The default uid is a 32-bit length string with numbers and alphabets. You can change the uid size with `uid_size: <size>`. If you want to generate the uid with your own way, please see [Redefine uid generation].
+
+### Read Only
+
+The uid is read only by default. You can disabled it with `read_only: false`.
+
+## Options for ActiveRecord
+
+### Uniqueness and Presence Validation
+
+The uniqueness and presence validation is enabled by default. You can disable them with `uniqueness: false` and `presence: false`. Note that you should change your migration as well if needed.
+
+### Set to_param
+
+If the option `set_to_param: true` is given, the `to_param` is overrided with uid and it means you can use uid in your routes path.
+
+### Scope
+
+If the option `scope: true` is given, a scope `with_uid` is created and you can use it to find records with uid. Note that if you change the uid name with the option `uid_name: <name>`, the scope is also changed to `with_<name>`.
+
+## Redefine Uid Generation
+
+You override `gen_uid` method in your class/model if you want to generate your own uid. Here is an example:
+
+    require `random_token`
+
+    class MyModel < ActiveRecord::Base
+      include Uidable
+      uidable
+
+      private
+
+      def gen_uid
+        RandomToken.gen(64, s: 8)
+      end
+    end
+
+## Test
+
+Run `ruby test/test_all.rb`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/sibevin/uidable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Authors
+
+Sibevin Wang
+
+## Copyright
+
+Copyright (c) 2015 Sibevin Wang. Released under the MIT license.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uidable"
+
+# 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

data/bin/setup

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

data/lib/uidable/version.rb

@@ -0,0 +1,3 @@
+module Uidable
+  VERSION = "1.0.1"
+end

data/lib/uidable.rb

@@ -0,0 +1,63 @@
+require "uidable/version"
+
+module Uidable
+  DEFAULT_UID_SIZE = 32
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def uidable(
+        uid_name: "uid",
+        uid_size: DEFAULT_UID_SIZE,
+        read_only: true,
+        presence: true,
+        uniqueness: true,
+        set_to_param: false,
+        scope: false)
+      mod = Module.new
+      mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def self.included(base)
+          if defined?(::ActiveRecord::Base) && base < ::ActiveRecord::Base
+            base.before_validation :assign_uid, on: :create
+            #{ scope ? "base.scope :'with_#{uid_name}', -> (uid) { base.where(:'#{uid_name}' => uid) }" : "" }
+            #{ set_to_param ? "base.include SetToParam" : "" }
+            #{ read_only ? "base.attr_readonly :'#{uid_name}'" : "" }
+          else
+            base.prepend InitUid
+            #{ read_only ? "attr_reader :'#{uid_name}'" : "attr_accessor :'#{uid_name}'" }
+          end
+          if base.respond_to?(:validates)
+            #{ presence ? "base.validates :'#{uid_name}', presence: true" : "" }
+            #{ uniqueness ? "base.validates :'#{uid_name}', uniqueness: true" : "" }
+          end
+        end
+
+        module InitUid
+          def initialize
+            @#{uid_name} = gen_uid
+            super
+          end
+        end
+
+        module SetToParam
+          def to_param
+            self.#{uid_name}
+          end
+        end
+
+        private
+
+        def assign_uid
+          self.#{uid_name} = gen_uid
+        end
+
+        def gen_uid
+          Array.new(#{uid_size}){[*'a'..'b', *'0'..'9'].sample}.join
+        end
+      RUBY
+      include mod
+    end
+  end
+end

data/uidable.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uidable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uidable"
+  spec.version       = Uidable::VERSION
+  spec.authors       = ["Sibevin Wang"]
+  spec.email         = ["sibevin@gmail.com"]
+
+  spec.summary       = %q{Create the uid attribute in your model or class.}
+  spec.description   = <<-EOF
+    Uidable is a module to add a uid(unique identifier) attribute in your model or class.
+    With ActiveRecord, the presence and uniqueness validations are supported.
+  EOF
+  spec.homepage      = "https://github.com/sibevin/uidable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: uidable
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Sibevin Wang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: |2
+      Uidable is a module to add a uid(unique identifier) attribute in your model or class.
+      With ActiveRecord, the presence and uniqueness validations are supported.
+email:
+- sibevin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/uidable.rb
+- lib/uidable/version.rb
+- uidable.gemspec
+homepage: https://github.com/sibevin/uidable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Create the uid attribute in your model or class.
+test_files: []