sequenceid 0.0.2 → 0.0.3

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+.DS_Store
+*.swp

data/README.md

@@ -0,0 +1,81 @@
+# SequenceId
+
+SequenceId is the gem for Rails 3 that allows for creating URL permalinks that start from 1 and increment in a continuum. 
+As an example for a SaaS based accounting application using SequenceId, you'll have the first three URL's for a new signup like:
+
+    http://company1.7vals.com/invoices/1
+    http://company1.7vals.com/invoices/2
+    http://company1.7vals.com/invoices/3
+
+instead of:
+
+    http://company1.7vals.com/invoices/11232
+    http://company1.7vals.com/invoices/11240 #notice a jump of 8 id's due to other companies creating their invoices
+    http://company1.7vals.com/invoices/11242
+
+## SequenceId Features
+
+SequenceId is a fairly straight forward gem and you need to ensure only ONE condition
+    Resource with sequenceid must be a NESTED resource
+
+Back to our original example, if you want invoices to start from 1 for each new company, the Invoice RESOURCE is nested to the Company RESOURCE. The gem will check for the relationhip in the database (Invoice table in this case) and ensure the sequence_num (SequenceId column created in the table)  and the parent resource_id are a secondary compound key in the nested resource's table. 
+
+SequenceId is compatible with Active Record  **3.0**.
+
+## Docs, Info and Support
+
+* [Bugs/Help](https://groups.google.com/group/sequenceid)
+* Email: info@7vals.com 
+
+## Rails Quickstart
+
+    rails new my_app
+
+    cd my_app
+
+    # add to Gemfile
+    gem "sequenceid"
+
+    rails generate sequenceid <parent resource> <nested resource> #eg rails generate sequenceid Company Invoice 
+
+    rake db:migrate
+
+    # edit app/controller/invoices_controller.rb
+    # :id is NO LONGER a unique identifier since its the sequence_num, so you MUST edit the resource find in each of the actions (or create a before filter)
+    @company = Company.find(params[:company_id]) # or Company.find_by_name(request.subdomain)
+    @invoice = @company.invoices.find_by_sequence_num!(params[:id])
+
+    rails server
+
+    #i assuming you have 7vals mapped to localhost in your host file
+
+    GET http://company1.7vals.com:3000/invoices/1
+    Get http://company2.7vals.com:3000/invoices/1
+
+## Bugs
+
+Please report them on the [Github issue tracker](http://github.com/alisyed/sequenceid/issues)
+for this project.
+
+If you have a bug to report, please include the following information:
+
+* **Version information for SequenceId, Rails and Ruby.**
+* Stack trace and error message.
+* Any snippets of relevant model, view or controller code that shows how your
+  are using SequenceId
+
+## Credits
+
+SequenceId was create by Syed Ali @ 7vals 
+*   [7vals](http://www.7vals.com)
+
+Special thanks to
+*   [cancan](https://github.com/ryanb/cancan)
+
+*   [FriendlyId](https://github.com/norman/friendly_id)
+
+for serving as a template on certain best practices.
+
+Thanks!
+
+Copyright (c) 2011, released under the MIT license.

data/lib/generators/sequenceid/sequenceid_generator.rb

@@ -2,7 +2,7 @@ require 'rails/generators/active_record'
 
 class SequenceidGenerator < ActiveRecord::Generators::Base
   #Rails::Generators::NamedBase
-  desc "This generator is for sequenceid, which creates sequential id's in the URL for nested resources. Especially useful for SaaS based apps where the unique resource is likely a nested resource of company"
+  desc "This generator is for sequenceid, which creates sequential id's in the URL for nested resources. Especially useful for SaaS based apps where the unique resource is likely a nested resource of company\n Usage: rails generate sequenceid <parent resource> <nested resource>"
   ORM=ActiveRecord::Base #TODO: Make this generic for other ORM's
   source_root File.expand_path("../template",__FILE__)
 
@@ -47,6 +47,6 @@ class SequenceidGenerator < ActiveRecord::Generators::Base
     migration_template "migration.rb", "db/migrate/add_sequence_num_to_#{@nested_resource.to_s.downcase.pluralize}"
     #inject into model class module includeA
     @model_path ||= File.join("app", "models", "#{@nested_resource.to_s.underscore}.rb")
-    inject_into_class(@model_path,@nested_resource,"sequenceid :'#{@parent_resource.to_s}','#{@nested_resource.to_s.downcase.pluralize}\n")
+    inject_into_class(@model_path,@nested_resource,"sequenceid '#{@parent_resource.to_s.downcase}','#{@nested_resource.to_s.downcase.pluralize}'\n")
   end
 end

data/lib/sequenceid/version.rb

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

data/sequenceid.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["info@7vals.com"]
   s.homepage    = ""
   s.summary     = %q{Create resource URL's starting from 1 for each SaaS company}
-  s.description = %q{For SaaS applications, there are times when we dont want to show the resource id to the user since its being shared with multiple companies that have signed up. And for scenarios where we want the URL to show numbers and not worded URL's like what friendly_id provide, this is the gem for you! It'll create id's sequentially starting from 1 for each relation parent/nested resource relation defined}
+  s.description = %q{For SaaS applications, there are times when we dont want to show the resource id to the user since its being shared with multiple companies that have signed up. And for scenarios where we want the URL to show numbers and not worded URL's like what friendly_id provide, this is the gem for you! It'll create id's sequentially starting from 1 for each relation parent/nested resource relation definedi\n Feel free to get in touch for any specific questions until the help, support group and readme are not done at info@7vals.com \n http://www.7vals.com}
 
   s.rubyforge_project = "sequenceid"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sequenceid
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Syed Ali
@@ -15,10 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-26 00:00:00 Z
+date: 2011-05-31 00:00:00 Z
 dependencies: []
 
-description: For SaaS applications, there are times when we dont want to show the resource id to the user since its being shared with multiple companies that have signed up. And for scenarios where we want the URL to show numbers and not worded URL's like what friendly_id provide, this is the gem for you! It'll create id's sequentially starting from 1 for each relation parent/nested resource relation defined
+description: For SaaS applications, there are times when we dont want to show the resource id to the user since its being shared with multiple companies that have signed up. And for scenarios where we want the URL to show numbers and not worded URL's like what friendly_id provide, this is the gem for you! It'll create id's sequentially starting from 1 for each relation parent/nested resource relation definedi\n Feel free to get in touch for any specific questions until the help, support group and readme are not done at info@7vals.com \n http://www.7vals.com
 email: 
 - info@7vals.com
 executables: []
@@ -28,12 +28,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .DS_Store
+- .README.swp
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
+- lib/.DS_Store
 - lib/generators/sequenceid/sequenceid_generator.rb
 - lib/generators/sequenceid/template/migration.rb
 - lib/sequenceid.rb
+- lib/sequenceid/.DS_Store
 - lib/sequenceid/model_adapters/active_record_adapter.rb
 - lib/sequenceid/model_adapters/sequenceid_logic.rb
 - lib/sequenceid/version.rb