universal_identifiable 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57d356a3279a05731606bd16018ade06d8284339
-  data.tar.gz: b1f2933c79064267a17121992dcd1ef75b204acd
+  metadata.gz: 3bc5d482d8dbeb285bec83b006c9433fd0cef381
+  data.tar.gz: 9e90ab652ffd0544d54f5564b997efc31b08d20c
 SHA512:
-  metadata.gz: 1154a180ee96aa3be95efc3f55f18864ac547d674af617811948091c49521fa001fc5bbb1d5e43f9a3082983dc8e0abad4ea0c8b655783ae47ade4b1f86927c2
-  data.tar.gz: 6c382e83c10db9db0f27a944059f73b0fbc2f0511f383133cd91c085e82496f280ad6ca8f8e537e1bb2bd2f46696defeb47d672774139ab17c5c581626612c4c
+  metadata.gz: 5294c8ca97397018e88770739b39c6e1505bfc3229ff8dab4e03f56d941171791bd68488616f5c23c61e1f63ea35111ee6eb33880c2f35d3a53987e9665b7574
+  data.tar.gz: 4d2de664d3b195532e5a92dbaf294ff9a5c589a45baf45bc80418c79186e130f5b9d7a9a7d6b38c2ca38a556ed31bea87d812e99d562434c53d276b053a082ef

data/README.md

@@ -3,6 +3,8 @@
 Make your model uniq and identifiable through a readable name.
 Adds uuids to ActiveRecord models along with validators.
 
+[![Build Status](https://secure.travis-ci.org/neopoly/universal_identifiable.png?branch=master)](http://travis-ci.org/neopoly/universal_identifiable) [![Gem Version](https://badge.fury.io/rb/universal_identifiable.png)](http://badge.fury.io/rb/universal_identifiable) [![Code Climate](https://codeclimate.com/github/neopoly/universal_identifiable.png)](https://codeclimate.com/github/neopoly/universal_identifiable)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,7 +21,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a migration for your existing model with the built in generator.
+
+Example:
+<pre>
+rails g uuid Airport
+</pre>
+
+In your model:
+
+```ruby
+class Airport < ActiveRecord::Base
+  include UniversalIdentifiable
+end
+```
+Uuids must be prefixed with the modelname and namespaced with a dot. E.G: "airport.dortmund"
+
+Set a uuid like you would with any other attribute:
+
+```ruby
+airport = Airport.new(uuid: "airport.dortmund")
+```
+
+You have access to an unnamespaced uuid by passing the appropriate option:
+
+```ruby
+airport.uuid(namespaced: false)
+=> "dortmund"
+airport.uuid
+=> "airport.dortmund"
+```
+
+Validators:
+
+Two validators are automatically added to your model:
+
+```ruby
+validates :uuid, :presence => true, :uniqueness => true
+```
+TODO:
+
+- Automatically save uuid with corresponding modelname, seperated with namespacer.
 
 ## Contributing
 

data/lib/generators/templates/uuid_migration.rb.erb

@@ -0,0 +1,6 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    add_column :<%= table_name %>, :uuid, :string
+    add_index :<%= table_name %>, :uuid, :unique => true
+  end
+end

data/lib/generators/uuid_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/active_record'
+
+class UuidGenerator < ActiveRecord::Generators::Base
+
+  desc "Create a migration to add a uuid to your model. Pass your model name as an argument (required)."
+
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def generate_migration
+    migration_template "uuid_migration.rb.erb", "db/migrate/#{migration_file_name}"
+  end
+
+  private
+
+  def migration_file_name
+    "#{migration_name}.rb"
+  end
+
+  def migration_name
+    "add_uuid_to_#{name.underscore.pluralize}"
+  end
+
+  def migration_class_name
+    migration_name.camelize
+  end
+
+end

data/lib/universal_identifiable/version.rb

@@ -1,3 +1,3 @@
 module UniversalIdentifiable
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+require 'rails'
 require 'minitest/autorun'
 require 'minitest/spec'
 require 'universal_identifiable'

data/test/universal_identifier/universal_identifier_test.rb

@@ -9,9 +9,7 @@ module UniversalIdentifiable
     end
 
     it "is valid" do
-      assert @identifiable_model.uuid
-
-      @identifiable_model.valid?
+      assert @identifiable_model.valid?
 
       refute @identifiable_model.errors.full_messages.any? do |message|
         message.include? "uuid"

data/test/universal_identifier/uuid_generator_test.rb

@@ -0,0 +1,22 @@
+require "test_helper"
+require 'rails/generators'
+require 'generators/uuid_generator'
+
+class UuidGeneratorTest < Rails::Generators::TestCase
+
+  tests UuidGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+
+  setup :prepare_destination
+
+  test 'create migration' do
+    run_generator %w(Airport)
+
+    assert_migration 'db/migrate/add_uuid_to_airports.rb' do |migration|
+      assert_match /class AddUuidToAirports/, migration
+      assert_match /add_column :airports, :uuid, :string/, migration
+      assert_match /add_index :airports, :uuid, :unique => true/, migration
+    end
+  end
+
+end

data/universal_identifiable.gemspec

@@ -20,7 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-spec-rails"
   spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency 'railties'
   spec.add_runtime_dependency 'activerecord', '>= 3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: universal_identifiable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andreas Busold
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-spec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -93,10 +107,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/templates/uuid_migration.rb.erb
+- lib/generators/uuid_generator.rb
 - lib/universal_identifiable.rb
 - lib/universal_identifiable/version.rb
 - test/test_helper.rb
 - test/universal_identifier/universal_identifier_test.rb
+- test/universal_identifier/uuid_generator_test.rb
 - universal_identifiable.gemspec
 homepage: https://github.com/Kobra-Khan/universal_identifiable
 licenses:
@@ -125,3 +142,4 @@ summary: Adds uuids to ActiveRecord models along with validators.
 test_files:
 - test/test_helper.rb
 - test/universal_identifier/universal_identifier_test.rb
+- test/universal_identifier/uuid_generator_test.rb