protokoll 0.3.1 → 0.4.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011 YOURNAME
+Copyright 2012 CELSO DANTAS
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -67,9 +67,36 @@ Ex:
     
    # will produce => "2011HOUSE00001", "2011HOUSE00002"...
 
+== reserve_number!
+
+   object.reserve_number!
+
+Add a new intance method colled: "your_instance#reserve_#{column_name}!".
+With it you can reserve a number without the need to save it to the database. Ex:
+
+  car = Car.new
+  car.number
+  # => nil
+  car.reserve_number!
+  car.number
+  # => "CAR1100001"
+  # if you save it, the object will preserve the number: "CAR1100001"
+
+It just increases the counter so any other object that gets saved or uses the #reserve_#{column_name} will get the next available number.
+
+== Installation
+
+Just add to the Gemfile:
+ 
+   gem 'protokoll'
+
+And run _bundle install_ on the Rails application folder
+
+   bundle install
+
 == Questions & Sugestions
 This is my _first_ public gem, so if you have any questions os sugestions, feel free to contact me (use github msg system for that). It will be awesome to hear feedback to improve the code.
 
-
+The gem is still on early _alpha_ so you may find bugs on it. And if you do, please use the _Issues_ here in Github and I'd love to fix it.  
 
 This piece of software is free to use.

data/lib/generators/protokoll/migration/migration_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+module Protokoll
+  module Generators
+    class MigrationGenerator < ::Rails::Generators::Base
+      
+       include Rails::Generators::Migration
+      
+      desc "Generate protokoll migration" 
+      def create_migration_file
+        migration_name = "create_custom_auto_increments.rb"
+        migration_template migration_name, File.join('db', 'migrate', migration_name)
+      end
+      
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+    end
+  end
+end

data/lib/generators/protokoll/migration/templates/create_custom_auto_increments.rb

@@ -0,0 +1,15 @@
+class CreateCustomAutoIncrements < ActiveRecord::Migration
+  def up
+    create_table :custom_auto_increments, :force => true do |t|
+      t.string  :model_name
+      t.integer :counter, :default => 0
+      t.timestamps
+    end
+    
+    add_index :custom_auto_increment, :model_name
+  end
+
+  def down
+    drop_table :custom_auto_increment
+  end
+end

data/lib/protokoll/counter.rb

@@ -0,0 +1,33 @@
+require 'active_record'
+
+module Protokoll
+  class Counter
+    def self.next(object, options)
+      element = Models::CustomAutoIncrement.find_or_create_by_model_name(object.class.to_s.underscore)
+      
+      element.counter = 0 if outdated?(element, options)
+      element.counter += 1
+
+      element.save!
+      
+      Formater.new.format(element.counter, options)
+    end
+    
+    private 
+
+    def self.outdated?(record, options)
+      Time.now.strftime(update_event(options)).to_i > record.created_at.strftime(update_event(options)).to_i
+    end
+    
+    def self.update_event(options)
+      pattern = options[:pattern]
+      event = String.new
+
+      event += "%Y" if pattern.include? "%y" or pattern.include? "%Y"
+      event += "%m" if pattern.include? "%m"
+      event += "%H" if pattern.include? "%H"
+      event += "%M" if pattern.include? "%M"
+      event
+    end
+  end
+end

data/lib/protokoll/formater.rb

@@ -0,0 +1,79 @@
+
+module Protokoll
+  class Formater
+    def format(number, options)
+      @options = options
+      
+      build(number)
+    end
+    
+    private 
+    
+    # gets the next number.
+    # it prepends the prefix + counter + sufix
+    # ex:
+    #   "%Y####BANK" 
+    #   %Y => prefix (year)
+    #   #### => counter (starts with 0001)
+    #   BANK => sufix
+    # 
+    # if we are in 2011, the first model to be saved will get "20110001BANK"
+    # the next model to be saved will get "20110002BANK", "20110003BANK"...
+    #
+    #   number => is the counter
+    #   
+    #   next_custom_number(1) 
+    #   => "20110001BANK"
+    def build(number)
+      prefix(@options[:pattern]).to_s + 
+      counter(@options[:pattern], number).to_s + 
+      sufix(@options[:pattern]).to_s
+    end
+
+    def prefix(pattern)
+      prefx = extract_prefix(pattern)
+      expand_times(prefx.to_s)
+    end
+
+    def counter(pattern, n)
+      format_counter(digits_size(pattern), n)
+    end
+
+    def sufix(pattern)
+      sufx = extract_sufix(pattern)
+      expand_times(sufx.to_s)
+    end
+
+    def format_counter(zeros, value)
+      "%0#{zeros}d" % value
+    end
+
+    def extract_prefix(pattern)
+      # Company#### => Company
+      symbol = @options[:number_symbol]
+      (pattern =~ /^(\s|\d)*[^#{symbol}]+/ and $&)
+    end
+
+    def extract_sufix(pattern)
+      # ###Company => Company
+      symbol = @options[:number_symbol]
+      (pattern =~ /[^#{symbol}]+$/ and $&)
+    end
+
+    def expand_times(pattern)
+      pattern.sub!("%y", Time.now.strftime("%y"))
+      pattern.sub!("%Y", Time.now.strftime("%Y"))
+      pattern.sub!("%d", Time.now.strftime("%d"))
+      pattern.sub!("%m", Time.now.strftime("%m"))
+      pattern.sub!("%M", Time.now.strftime("%M"))
+      pattern.sub("%H",  Time.now.strftime("%H"))
+    end
+
+    def digits_size(pattern)
+      symbol = @options[:number_symbol]
+      (pattern =~ /[#{symbol}]+/ and $&).length
+    end
+
+
+  end  
+end

data/lib/protokoll/models/custom_auto_increment.rb

@@ -0,0 +1,8 @@
+require "active_record/base"
+
+module Protokoll
+  module Models
+    class CustomAutoIncrement < ActiveRecord::Base
+    end
+  end
+end

data/lib/protokoll/protokoll.rb

@@ -0,0 +1,34 @@
+module Protokoll
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    
+    # Class method available in models
+    # 
+    # == Example
+    #   class Order < ActiveRecord::Base
+    #      protokoll :number
+    #   end
+    #
+    def protokoll(column, _options = {})
+      options = { :pattern       => "%Y%m#####", 
+                  :number_symbol => "#",
+                  :column        => column }
+
+      options.merge!(_options)
+      
+      # Defining custom method
+      send :define_method, "reserve_#{options[:column]}!".to_sym do
+        self[column] = Counter.next(self, options)
+      end
+
+      # Signing before_create
+      before_create do |record|
+        return if record[column].present?
+
+        record[column] = Counter.next(self, options)
+      end
+    end
+  end
+  
+end

data/lib/protokoll/version.rb

@@ -1,3 +1,3 @@
 module Protokoll
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/protokoll.rb

@@ -1,39 +1,6 @@
-require "protokoll/auto_increment"
-require "protokoll/extract_number"
-require "protokoll/class_variable"
-
-module Protokoll
-  extend ActiveSupport::Concern
-
-  module ClassMethods
-    def protokoll(column = nil, _options = {})
-      ClassVariable.add_to self, :@@protokoll, :default => AutoIncrement.new
-      
-      prot = ClassVariable.get_from self, :@@protokoll
-      return prot if column.nil? 
-      
-      options = { :pattern => "%Y%m#####", :number_symbol => "#"}
-      options.merge!(_options)
-      
-      prot.options = options          
-          
-      before_create do |record|      
-        last = record.class.last
-        
-        if last.present?
-          if prot.outdated?(last)
-            prot.count = 0 
-          else
-            prot.count = ExtractNumber.number(last[column], options[:pattern]) 
-          end
-        end
-        
-        prot.count += 1
-        record[column] = prot.next_custom_number(column, prot.count)
-      end
-    end
-  end
-  
-end
+require "protokoll/models/custom_auto_increment"
+require "protokoll/formater"
+require "protokoll/counter"
+require "protokoll/protokoll"
 
 ActiveRecord::Base.send :include, Protokoll

data/test/dummy/app/models/call_defined_in_tests.rb

@@ -0,0 +1,7 @@
+# As I need to change the class a lot, I'm defining (and redefining tons of times)
+# in the tests files.
+# I'm just keeping the model here to make easy to understand what models
+# are been used in the test.
+
+# class Call < ActiveRecord::Base
+# end

data/test/dummy/app/models/protocol_defined_in_tests.rb

@@ -0,0 +1,7 @@
+# As I need to change the class a lot, I'm defining (and redefining tons of times)
+# in the tests files.
+# I'm just keeping the model here to make easy to understand what models
+# are been used in the test.
+
+# class Protocol < ActiveRecord::Base
+# end 

data/test/dummy/db/migrate/20120222164124_create_custom_auto_increments.rb

@@ -0,0 +1,15 @@
+class CreateCustomAutoIncrements < ActiveRecord::Migration
+  def up
+    create_table :custom_auto_increments, :force => true do |t|
+      t.string  :model_name
+      t.integer :counter, :default => 0
+      t.timestamps
+    end
+    
+    add_index :custom_auto_increments, :model_name
+  end
+
+  def down
+    drop_table :custom_auto_increments
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,24 +11,33 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20110928013630) do
+ActiveRecord::Schema.define(:version => 20120222164124) do
 
   create_table "calls", :force => true do |t|
     t.string   "number"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
   end
 
+  create_table "custom_auto_increments", :force => true do |t|
+    t.string   "model_name"
+    t.integer  "counter",    :default => 0
+    t.datetime "created_at",                :null => false
+    t.datetime "updated_at",                :null => false
+  end
+
+  add_index "custom_auto_increments", ["model_name"], :name => "index_custom_auto_increments_on_model_name"
+
   create_table "principals", :force => true do |t|
     t.string   "protokoll_number"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at",       :null => false
+    t.datetime "updated_at",       :null => false
   end
 
   create_table "protocols", :force => true do |t|
     t.string   "number"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
   end
 
 end