protokoll 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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.rdoc

@@ -0,0 +1,69 @@
+= Protokoll
+
+Protokoll is a simple Rails 3 pluggin to simplify the management of a custom autoincrement value for a model. 
+
+If you want to create an autoincrement information on the database, just like those callcenter registration number (2011000001, 2011000002, 20110000003 and on) this gem is for you!
+
+All those tricky things to control like every month you have to reset the counter are gone! All you have to do is define a String column and let _Protokoll_ handle the rest:
+
+    # creating an autoincrement column based on Time
+    class Call < ActiveRecord::Base
+        protokoll :registry_number  # by default it uses "%Y%m#####"
+    end
+    
+    Time.local(2011)
+    call01 = Call.create
+    call01.registry_number
+    => "201100001"
+
+    call02 = Call.create
+    call02.registry_number
+    => "201100002"
+
+    Time.local(2012)
+
+    call03 = Call.create
+    call03.registry_number
+    => "201200001"			# restarts counter because if the first item of the year
+
+If you want to use your own pattern, just do this:
+
+    class Call < ActiveRecord::Base
+        protokoll :registry_number, :pattern => "some#####thing"
+    end
+    
+    # this will produce
+    call01 = Call.create
+    call01.registry_number
+    => "some00001thing"
+    
+    call02 = Call.create
+    call02.registry_number
+    => "some00002thing"
+
+Or use any time based format. You can use in the pattern any combination of:
+ # assume it's 2011/01/01 12:00
+ "%y" for year   	# => appends 11 
+ "%m" for month  	# => appends 01
+ "%d" for day	 	# => appends 01
+ "%H" for hour	 	# => appends 12
+ "%M" for minute 	# => appends 00
+ "#"  for the autoincrement number (use and long as you want)
+
+Ex:
+    # :number must be a String
+    class Car < ActiveRecord::Base
+        protokoll :number, :pattern => "CAR%y#####"
+    end
+    
+    # will produce => "CAR201100001", "CAR1100002"... 
+    
+    # :sell_number must be a String
+    class House < ActiveRecord::Base
+        protokoll :sell_number, :pattern => "%YHOUSE#####"
+    end
+    
+   # will produce => "2011HOUSE00001", "2011HOUSE00002"...
+__
+
+This piece of software is free to use.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ProtokollPlugin'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/protokoll/extract_number.rb

@@ -0,0 +1,25 @@
+module Protokoll
+  module ExtractNumber
+    def self.create_number_mask(format)
+      format.split("").map do |i|
+        (i == "#") ? 1 : 0
+      end
+    end
+
+    def self.extract_using_mask(db_number, mask)
+      result = db_number.split("").select.with_index do |n, i| 
+        n if mask[i] == 1
+      end
+      result.join.to_i
+    end
+
+    def self.number(str, pattern)
+      mask = create_number_mask( expand_pattern(pattern) )
+      extract_using_mask(str, mask)
+    end
+    
+    def self.expand_pattern(pattern)
+      pattern.sub("%Y", "0000")
+    end
+  end
+end

data/lib/protokoll/protokoll_auto_increment.rb

@@ -0,0 +1,89 @@
+module Protokoll
+
+  class ProtokollAutoIncrement    
+    attr_accessor :options
+    
+    def next_custom_number(column, 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
+      (pattern =~ /^(\s|\d)*[^#]+/ and $&)
+    end
+
+    def extract_sufix(pattern)
+      # ###Company => Company
+      (pattern =~ /[^#]+$/ 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)
+      (pattern =~ /[#]+/ and $&).length
+    end
+
+    def time_outdated?(pattern, record_date)
+      if (pattern.include? "%y") # year
+        return true if Time.now.year > record_date.year
+      end
+
+      if (pattern.include? "%m") # month
+        return true if Time.now.month > record_date.month
+      end
+
+      if (pattern.include? "%d") # day
+        return true if Time.now.day > record_date.day
+      end
+
+      if (pattern.include? "%H") # hour
+        return true if Time.now.hour > record_date.hour
+      end
+
+      if (pattern.include? "%M") # minute
+        return true if Time.now.minute > record_date.min
+      end
+    end
+
+    def outdated?(record)
+      Time.now.strftime(update_event).to_i > record.created_at.strftime(update_event).to_i
+    end
+
+    def update_event
+      pattern = options[:pattern]
+      return "%M" if pattern.include? "%M"
+      return "%H" if pattern.include? "%H"
+      return "%m" if pattern.include? "%m"
+      return "%y" if pattern.include? "%y" or pattern.include? "%Y"
+      return ""
+    end
+
+  end
+end

data/lib/protokoll/version.rb

@@ -0,0 +1,3 @@
+module Protokoll
+  VERSION = "0.1.0"
+end

data/lib/protokoll.rb

@@ -0,0 +1,53 @@
+require "protokoll/protokoll_auto_increment"
+require "protokoll/extract_number"
+
+module Protokoll
+  extend ActiveSupport::Concern
+  
+  module ClassMethods
+    @@protokoll_count = 0
+    @@protokoll_auto_increment 
+
+    def protokoll_count=(p)
+      @@protokoll_count = p
+    end
+    
+    def protokoll_count
+      @@protokoll_count
+    end
+    
+    def protokoll_pattern=(p)
+      @@protokoll_auto_increment.options[:pattern] = p
+    end
+    
+    def protokoll_pattern
+      @@protokoll_auto_increment.options[:pattern]
+    end
+    
+    def protokoll(column, _options = {})
+      options = { :pattern => "%Y%m#####", :number_symbol => "#"}
+      options.merge!(_options)
+
+      @@protokoll_auto_increment = ProtokollAutoIncrement.new
+      @@protokoll_auto_increment.options = options
+
+      before_save do |record|      
+        last = record.class.last
+        
+        if last.present?
+          if @@protokoll_auto_increment.outdated?(last)
+            @@protokoll_count = 0 
+          else
+            @@protokoll_count = ExtractNumber.number(last[column], options[:pattern]) 
+          end
+        end
+        
+        @@protokoll_count += 1
+        record[column] = @@protokoll_auto_increment.next_custom_number(column, @@protokoll_count)
+      end
+    end
+  end
+  
+end
+
+ActiveRecord::Base.send :include, Protokoll

data/lib/tasks/protokoll_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :protocol_number_plugin do
+#   # Task goes here
+# end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

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

@@ -0,0 +1,2 @@
+class Principal < ActiveRecord::Base
+end

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

@@ -0,0 +1,3 @@
+class Protocol < ActiveRecord::Base
+  protokoll :number
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "protokoll"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000