code_generator 0.0.3 → 0.0.4

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/README.md

@@ -21,28 +21,51 @@ Or install it yourself as:
 Really simple:
 
     # creating random token
-    token = CodeGenerator::Generate.generate
+    token = CodeGenerator::Generator.generate
     
     # specific length
-    token = CodeGenerator::Generate.generate(length: 10)
+    token = CodeGenerator::Generator.generate(length: 10)
 
     # unique for particular field in a model
-    token = CodeGenerator::Generate.generate(uniqueness: { model: :user, field: :confirmation_code })
+    token = CodeGenerator::Generator.generate(uniqueness: { model: :user, field: :confirmation_code })
+
+## ORM - ActiveRecord/Mongoid
+
+When using ActiveRecord or Mongoid as your rails project ORM, it also provides you the class method tokenify! that can be used to generate random, unique tokens for the specified field.
+
+    # ActiveRecord
+    class Service
+      attr_accessible :auth_token
+      
+      tokenify!(:auth_token, length: 16)
+    end
+
+    # Mongoid
+    class Service
+      include Mongoid::CodeGenerator
+      field :auth_token, type: String
+      
+      tokenify!(:auth_token, unique: true)
+    end
+    
+In addition, you can pass the *:length (default: 10)* and *:unique (default: false)* options also.
 
 ## Configuration
 
-You can configure the tokens to be generated. Simply create a new code_generator.rb file in your /config/initializers folder of your rails project:
+You can configure the tokens to be generated. Simply create a new *'code_generator.rb'* file in the *'/config/initializers'* folder of your rails project:
 
     CodeGenerator.configure do |code|
-      code.length         = 6               # length of the tokens to be generated.
+      code.length         = 6               # length of the tokens to be generated. (default: 10)
       code.use_chars      = :numeric        # type of token to be generated. (default: :alpha_numeric)
-      code.invalid_chars  = [ 0, 1, 7 ]     # do not use these characters.
-      code.valid_chars    = [ 3, 4, 5, 6 ]  # use only these characters (ignores :use_chars).
-      code.include_chars  = [ "$", "%" ]    # use these characters as well (does not ignore :use_chars).
+      code.invalid_chars  = [ 0, 1, 7 ]     # do not use these characters. (default: none)
+      code.valid_chars    = [ 3, 4, 5, 6 ]  # use only these characters (ignores :use_chars). (default: none)
+      code.include_chars  = [ "$", "%" ]    # use these characters as well (does not ignore :use_chars). (default: none)
       code.repeat_chars   = false           # each character to be used once. (default: true)
     end
 
-You can use :alpha, :lower_alpha, :upper_alpha, :numeric, :lower_alpha_numeric, :upper_alpha_numeric, :alpha_numeric as various token types. Default is :alpha_numeric.
+You can use *:alpha (a-Z), :lower_alpha (a-z), :upper_alpha (A-Z), :numeric (0-9), :lower_alpha_numeric (a-z, 0-9), :upper_alpha_numeric (A-Z, 0-9), :alpha_numeric (a-Z, 0-9)* as various token types. Default is *:alpha_numeric*.
+
+**Note** - These configuration settings apply to the 'tokenify!' method as well.
 
 ## Contributing
 
@@ -54,8 +77,8 @@ You can use :alpha, :lower_alpha, :upper_alpha, :numeric, :lower_alpha_numeric,
 
 ## Contributors
 
-[Jitendra Rai](https://github.com/jitendra)
-[Bharat Gupta](https://github.com/Bharat311)
+* [Jitendra Rai](https://github.com/jitendra)
+* [Bharat Gupta](https://github.com/Bharat311)
 
 ## License
 

data/code_generator.gemspec

@@ -4,9 +4,9 @@ require "code_generator/version"
 Gem::Specification.new do |s|
   s.name          = 'code_generator'
   s.version       = CodeGenerator::VERSION
-  s.date          = '2013-06-05'
-  s.summary       = "A alpha-numeric code generator"
-  s.description   = "A alpha-numeric code generator"
+  s.date          = '2013-06-09'
+  s.summary       = "An alpha-numeric code generator for rails"
+  s.description   = "An alpha-numeric code generator for rails"
   s.authors       = ["Bharat Gupta"]
   s.email         = 'bindassbharat311@gmail.com'
   s.files         = `git ls-files`.split("\n")

data/lib/code_generator.rb

@@ -1,2 +1,5 @@
 require "code_generator/configure"
-require "code_generator/generator"
+require "code_generator/generator"
+
+require "code_generator/orms/mongoid"          if defined? ::Mongoid
+require "code_generator/orms/active_record"    if defined? ::ActiveRecord

data/lib/code_generator/configure.rb

@@ -2,8 +2,8 @@ module CodeGenerator
   
   LOWER_ALPHA         = ('a'..'z').to_a
   UPPER_ALPHA         = ('A'..'Z').to_a
-  ALPHA               = LOWER_ALPHA + UPPER_ALPHA
   NUMERIC             = (0..9).to_a
+  ALPHA               = LOWER_ALPHA + UPPER_ALPHA
   LOWER_ALPHA_NUMERIC = LOWER_ALPHA + NUMERIC
   UPPER_ALPHA_NUMERIC = UPPER_ALPHA + NUMERIC
   ALPHA_NUMERIC       = ALPHA + NUMERIC
@@ -15,7 +15,7 @@ module CodeGenerator
   @@use_chars = :alpha_numeric
 
   mattr_accessor :include_chars
-  @@include_chars = nil
+  @@include_chars = Array.new
   
   mattr_accessor :invalid_chars
   @@invalid_chars = Array.new
@@ -26,16 +26,17 @@ module CodeGenerator
   @@repeat_chars = true
   
   class << self
+    
     def configure
       yield self
     end
     
     def valid_characters
       return @@valid_chars if @@valid_chars
-      _chars    = "CodeGenerator::#{use_chars.upcase}".constantize
-      _chars   |=  include_chars unless include_chars.empty?
-      _invalid  = invalid_chars
-      @@valid_chars = _chars - _invalid
+      _all_chars    = "CodeGenerator::#{use_chars.upcase}".constantize
+      _all_chars   |= include_chars unless include_chars.empty?
+      _invalid      = invalid_chars
+      @@valid_chars = _all_chars - _invalid
     end
   end
     

data/lib/code_generator/orms/active_record.rb

@@ -0,0 +1,7 @@
+require "code_generator/tokenify"
+
+class ActiveRecord::Base
+  
+  include ::CodeGenerator::Tokenify
+   
+end

data/lib/code_generator/orms/mongoid.rb

@@ -0,0 +1,10 @@
+require "code_generator/tokenify"
+
+module Mongoid
+  module CodeGenerator
+    extend ActiveSupport::Concern
+    
+    include ::CodeGenerator::Tokenify
+    
+  end
+end

data/lib/code_generator/tokenify.rb

@@ -0,0 +1,20 @@
+module CodeGenerator
+  module Tokenify
+    extend ActiveSupport::Concern
+  
+    module ClassMethods
+      def tokenify!(field, opts = {})
+        opts[:uniqueness] = { model: self.to_s.underscore, 
+                              field: field } if opts.delete(:unique)
+        
+        after_initialize do |record|
+          if record.send(field).blank?
+            token = CodeGenerator::Generator.generate(opts)
+            record.send("#{field}=", token)
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/code_generator/version.rb

@@ -1,5 +1,5 @@
 module CodeGenerator
   
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.4".freeze
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,15 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-05 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies: []
-description: A alpha-numeric code generator
+description: An alpha-numeric code generator for rails
 email: bindassbharat311@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -25,6 +26,9 @@ files:
 - lib/code_generator.rb
 - lib/code_generator/configure.rb
 - lib/code_generator/generator.rb
+- lib/code_generator/orms/active_record.rb
+- lib/code_generator/orms/mongoid.rb
+- lib/code_generator/tokenify.rb
 - lib/code_generator/version.rb
 homepage: https://github.com/Bharat311/code_generator
 licenses: []
@@ -49,5 +53,5 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: A alpha-numeric code generator
+summary: An alpha-numeric code generator for rails
 test_files: []