sequenceid 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/generators/sequenceid/sequenceid_generator.rb

@@ -0,0 +1,52 @@
+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"
+  ORM=ActiveRecord::Base #TODO: Make this generic for other ORM's
+  source_root File.expand_path("../template",__FILE__)
+
+  def initialize_sequenceid
+    parent_resource_s=@_initializer[0][0]
+    nested_resource_s=@_initializer[0][1]
+    if (!parent_resource_s || !nested_resource_s)
+      puts "Usage: rails generate sequenceid <parent resource> <nested resource> "
+      puts "eg, rails generate company user"
+      puts "the nested resource must be in someway nested to the parent resource to avoid a conflict in url's"
+      puts "eg, if a company is represented by subdomain of the url, you will always have a unique url for the user even though the sequence id's might be shared"
+      puts "so if two company's exist, 7vals and sevenvals, then their first users will have urls: http://7vals.easyofficeinventory.com/users/1 and http://sevenvals.easyofficeinventory.com/users/1"
+      puts "note how the users/1 is now used to get the sequence number and NOT the unique id of the user"
+      exit
+    end
+    begin
+      @parent_resource=eval parent_resource_s.classify
+      @nested_resource=eval nested_resource_s.classify
+      if((!@parent_resource.ancestors.include?ORM) || (!@nested_resource.ancestors.include?ORM))
+        puts "both #{parent_resource_s} and #{nested_resource_s} need to be ActiveRecords"
+        exit
+      end
+
+      if((!@nested_resource.new.respond_to? parent_resource_s) & (!@nested_resource.new.respond_to? parent_resource_s.pluralize))
+        puts "#{nested_resource_s} should have an association with #{parent_resource_s} otherwise its not possible to have a unique sequence number to identify #{nested_resource_s} from the url"
+        #TODO need to check for belongs_to relation
+        exit
+      end
+      #if not belongs to
+      if(!@parent_resource.new.respond_to? @nested_resource.to_s.downcase.pluralize)
+        exit unless yes?("The resource #{nested_resource_s} should have a belongs to association with #{parent_resource_s}, do you still want to continue (risky)?")
+      end
+
+    rescue =>e
+      puts "both #{parent_resource_s} and #{nested_resource_s} need to be ActiveRecords #{e.message}"
+      exit
+    end
+  end
+
+  def do_work
+    #create migration and run migrate script
+    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")
+  end
+end

data/lib/generators/sequenceid/template/migration.rb

@@ -0,0 +1,26 @@
+class AddSequenceNumTo<%= @nested_resource.to_s.downcase.pluralize.camelize %> < ActiveRecord::Migration
+  <% @parent_resource_name=@parent_resource.to_s.downcase%>
+  <% @nested_resource_name=@nested_resource.to_s.downcase.pluralize%>
+  def self.up
+    add_column :<%= @nested_resource_name %>, :sequence_num, :integer,:null=>false
+    update_sequence_num_values
+    add_index :<%= @nested_resource_name%>, [:sequence_num,:<%=@parent_resource_name%>_id], :unique=>true
+  end
+
+  def self.down
+    remove_index :<%=@nested_resource_name%>,:column=>[:sequence_num,:<%=@parent_resource_name%>_id]
+    remove_column :<%=@nested_resource_name%>, :sequence_num
+  end
+
+  def self.update_sequence_num_values
+    <%=@parent_resource.to_s%>.all.each do |parent|
+      cntr=1
+      parent.<%=@nested_resource_name%>.order("created_at").all.each do |nested|
+        nested.sequence_num =cntr
+        cntr+=1
+        nested.save
+      end
+    end
+  end
+end
+

data/lib/sequenceid/sequenceid/model_adapters/active_record_adapter.rb

@@ -0,0 +1,5 @@
+require 'sequenceid/model_adapters/sequenceid_logic'
+ActiveRecord::Base.class_eval do
+  extend Sequenceid::Logic
+end
+

data/lib/sequenceid/sequenceid/model_adapters/sequenceid_logic.rb

@@ -0,0 +1,42 @@
+module Sequenceid
+  module Logic
+
+    def sequenceid(parent_rel,current_rel)
+      #TODO:need to ensure multiple before_saves are not added - possibly use respond_to?
+      class_eval do
+        before_create :set_sequence_num
+        after_rollback :reset_sequence_num
+        include InstanceMethods
+      end
+      @relation_for_sequence_string=(parent_rel+"."+current_rel)
+    end
+
+    module InstanceMethods
+      def to_param
+        "#{sequence_num}"
+      end
+
+      protected
+      def set_sequence_num
+        if new_record?
+	  @relation_sequence=self.send @relation_for_sequence_string
+          self.sequence_num=@relation_sequence.order("id").last.try(:sequence_num) || 0
+          self.sequence_num+=1
+        end
+        return true
+      end
+
+      def reset_sequence_num
+        @save_counter||=1
+        if new_record? && @save_counter<3
+          logger.info "SQUENCENUM:: attempt number #{@save_counter} of a max 2"
+          self.sequence_num=@relation_sequence.order("id").last.try(:sequence_num) +1
+          @save_counter+=1
+          save
+        else
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/sequenceid/sequenceid/version.rb

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

data/lib/sequenceid/version.rb

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

data/lib/sequenceid.rb

@@ -0,0 +1,2 @@
+require 'sequenceid/model_adapters/active_record_adapter' if defined? ActiveRecord
+

data/sequenceid.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sequenceid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sequenceid"
+  s.version     = Sequenceid::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Syed Ali"]
+  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.rubyforge_project = "sequenceid"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: sequenceid
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Syed Ali
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-26 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
+email: 
+- info@7vals.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/generators/sequenceid/sequenceid_generator.rb
+- lib/generators/sequenceid/template/migration.rb
+- lib/sequenceid.rb
+- lib/sequenceid/sequenceid/model_adapters/active_record_adapter.rb
+- lib/sequenceid/sequenceid/model_adapters/sequenceid_logic.rb
+- lib/sequenceid/sequenceid/version.rb
+- lib/sequenceid/version.rb
+- sequenceid.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sequenceid
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Create resource URL's starting from 1 for each SaaS company
+test_files: []
+