mad_id 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f7151e5b6b6e1b85ce61310bee3e7261af373bc
+  data.tar.gz: 4d3a29c03becf7d3c0447889d2aeb488fd5be28e
+SHA512:
+  metadata.gz: 3b9cdc1473f81f082551ee543b891ae1d383971d90bd5868e2c50f0275c7dbfd3975429f30a9c15f8e05507023c7e6f7f2398f448e422ebd2d06fa43929c88f2
+  data.tar.gz: 2d210548a728c1a9fc96bdbfef3b47448873a640e400463878496861e204f7669be7deb3dccb97e0fc7e6dc2fe6efb386d70ca2a6109da51cc085abd336db45a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lars Brillert
+
+MIT License
+
+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,56 @@
+# MadId
+
+Will can help you to inject easy identifiers into your `ActiveRecord` models.
+
+It will:
+
+  * set up a `before_save` callback to set `identifier`
+  * override `to_param` to return `identifier`
+  * give you a `short_identifer` that returns the first 12 chars of `identifier`
+
+Rightnow its very opinonated and not configurable in any way, this might change.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mad_id'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mad_id
+
+## Usage
+
+### Rails
+
+    class YourModel < ActiveRecord::Base
+      identify_with :foo
+    end
+
+after you create the object it will have the `identifier` attribute set to
+
+    "foo-<UUID>"
+
+### Plain
+
+If your not using Rails you'll have to include `MadId` on your own
+
+    class YourModel < ActiveRecord::Base
+      include MadID
+
+      identify_with :baz
+    end
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/mad_id/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mad_id/identity_methods.rb

@@ -0,0 +1,28 @@
+module MadId
+
+  module IdentityMethods
+    extend ActiveSupport::Concern
+
+    included do
+      before_save :set_identifier, on: :create
+
+      def self.object_identifier_prefix
+        @identifier
+      end
+    end
+
+    def set_identifier
+      self.identifier = "#{self.class.object_identifier_prefix}-#{SecureRandom.uuid}"[0..34]
+    end
+
+    def short_identifier
+      self.identifier[0..11]
+    end
+
+    def to_param
+      self.identifier
+    end
+
+  end
+
+end

data/lib/mad_id/railtie.rb

@@ -0,0 +1,9 @@
+module MadId
+  class Railtie < ::Rails::Railtie
+    initializer 'mad_id.initialize' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send(:include, MadId)
+      end
+    end
+  end
+end

data/lib/mad_id/version.rb

@@ -0,0 +1,3 @@
+module MadId
+  VERSION = "0.0.1"
+end

data/lib/mad_id.rb

@@ -0,0 +1,20 @@
+require "mad_id/version"
+
+require "active_record"
+require "active_support"
+
+require "mad_id/identity_methods"
+require "mad_id/railtie" if defined?(Rails)
+
+module MadId
+  extend ActiveSupport::Concern
+
+  included do
+    def self.identify_with(value)
+      @identifier = value
+
+      self.send(:include, MadId::IdentityMethods)
+    end
+  end
+
+end

data/mad_id.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mad_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mad_id"
+  spec.version       = MadId::VERSION
+  spec.authors       = ["Lars Brillert"]
+  spec.email         = ["lars@railslove.com"]
+  spec.summary       = %q{Adds prefixed identifiers to your models.}
+  spec.homepage      = "https://github.com/kangguru/mad_id"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 4.1.1"
+  spec.add_dependency "activesupport", "~> 4.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-collection_matchers"
+end

data/spec/mad_id_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+class Pony < ActiveRecord::Base
+  include MadId
+end
+
+class LittlePony < Pony
+  identify_with :pny
+end
+
+describe MadId do
+
+  it 'inserts #identify_with' do
+    expect(Pony.respond_to?(:identify_with)).to be(true)
+  end
+
+  it 'wont set any callbacks' do
+    expect(Pony._save_callbacks.select {|cb| cb.filter == :set_identifier}).to be_empty
+  end
+
+  describe 'when #identify_with is called' do
+    subject { LittlePony.new }
+
+    it 'inserts the #set_identifier callback' do
+      expect(LittlePony._save_callbacks.select {|cb| cb.filter == :set_identifier}).to have(1).item
+    end
+
+    describe '#to_param' do
+      before { subject.set_identifier }
+      it 'will return the identifier' do
+        expect(subject.to_param).to eq(subject.identifier)
+      end
+    end
+
+    describe '#short_identifier' do
+      before { subject.set_identifier }
+      it 'will shorten the identifier to the first 12 chars' do
+        expect(subject.short_identifier).to eq(subject.identifier[0..11])
+      end
+    end
+
+    describe '#identifier' do
+      before { subject.set_identifier }
+      it 'will start with the #identify_with argument' do
+        expect(subject.identifier).to match(/pny-.+/)
+      end
+    end
+
+    describe 'callbacks' do
+      subject { LittlePony.new }
+
+      it 'will set the identifier upon create' do
+        expect{ subject.save! }.to change{ subject.identifier }.from(nil)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'mad_id'
+require 'rspec'
+require 'rspec/collection_matchers'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.color = true
+  config.order = "random"
+end

data/spec/support/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(version: 1) do
+  create_table "ponies", force: true do |t|
+    t.string  "identifier"
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: mad_id
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lars Brillert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: rspec-collection_matchers
+  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: 
+email:
+- lars@railslove.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mad_id.rb
+- lib/mad_id/identity_methods.rb
+- lib/mad_id/locator.rb
+- lib/mad_id/railtie.rb
+- lib/mad_id/version.rb
+- mad_id.gemspec
+- spec/mad_id_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+- spec/support/schema.rb
+homepage: https://github.com/kangguru/mad_id
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adds prefixed identifiers to your models.
+test_files:
+- spec/mad_id_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+- spec/support/schema.rb