code_generator 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1 @@
+todo.txt

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bharat Gupta
+
+MIT License
+
+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.md

@@ -0,0 +1,61 @@
+# CodeGenerator
+
+Easily create unique and random tokens for your use.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'code_generator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install code_generator
+
+## Usage
+
+Really simple:
+
+    # creating random token
+    token = CodeGenerator.generate
+    
+    # specific length
+    token = CodeGenerator.generate(length: 10)
+
+    # unique for particular field in a model
+    token = CodeGenerator.generator(uniqueness: { scope: :user, field: :confirmation_code })
+
+## 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:
+
+    CodeGenerator.configure do |code|
+      code.length         = 6               # length of the tokens to be generated.
+      code.use_chars      = :numeric        # type of token to be generated.
+      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 (do not ignore :use_chars).
+    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.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Contributors
+
+[Jitendra Rai](https://github.com/jitendra)
+[Bharat Gupta](https://github.com/Bharat311)
+
+## License
+
+MIT License

data/code_generator.gemspec

@@ -0,0 +1,15 @@
+$:.push File.expand_path("../lib", __FILE__)
+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.authors       = ["Bharat Gupta"]
+  s.email         = 'bindassbharat311@gmail.com'
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.homepage      = 'https://github.com/Bharat311/code_generator'
+end

data/lib/code_generator.rb

@@ -0,0 +1,2 @@
+require "code_generator/configure"
+require "code_generator/generator"

data/lib/code_generator/configure.rb

@@ -0,0 +1,39 @@
+module CodeGenerator
+  
+  LOWER_ALPHA         = ('a'..'z').to_a
+  UPPER_ALPHA         = ('A'..'Z').to_a
+  ALPHA               = LOWER_ALPHA + UPPER_ALPHA
+  NUMERIC             = (0..9).to_a
+  LOWER_ALPHA_NUMERIC = LOWER_ALPHA + NUMERIC
+  UPPER_ALPHA_NUMERIC = UPPER_ALPHA + NUMERIC
+  ALPHA_NUMERIC       = ALPHA + NUMERIC
+  
+  mattr_accessor :length
+  @@length = 10
+  
+  mattr_accessor :use_chars
+  @@use_chars = :alpha_numeric
+
+  mattr_accessor :include_chars
+  @@include_chars = nil
+  
+  mattr_accessor :invalid_chars
+  @@invalid_chars = Array.new
+  
+  mattr_accessor :valid_chars
+  
+  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
+    end
+  end
+    
+end

data/lib/code_generator/generator.rb

@@ -0,0 +1,64 @@
+module CodeGenerator
+
+  class ScopeNotSpecifiedError < StandardError; end
+  class FieldNotSpecifiedError < StandardError; end
+  class ClassNotFoundError < StandardError; end
+  
+  class Generator
+    
+    attr_reader :scoped_class
+    attr_accessor :length, :uniqueness
+  
+    def initialize(opts = {})
+      opts.symbolize_keys!
+      @length     = opts.delete(:length) || CodeGenerator.length
+      @uniqueness = opts.delete(:uniqueness)
+      set_scoped_class_and_field! if uniqueness
+    end
+  
+    def unique?
+      @scoped_class.send(:where, {@field_name => @code}).empty?
+    end
+    
+    def random_string
+      chars = CodeGenerator.valid_characters
+      Array.new(length){ chars.sample() }.join
+    end
+  
+    def generate_code
+      @code = random_string
+      if generate_unique?
+        @code = random_string until(unique?)
+      end
+      @code
+    end
+  
+    class << self
+      def generate(opts = {})
+        cg = new(opts)
+        cg.generate_code
+      end
+    end
+  
+    private
+  
+      def get_scoped_class
+        uniqueness[:scope].to_s.classify.constantize
+      rescue
+        raise CodeGenerator::ClassNotFoundError
+      end
+    
+      def set_scoped_class_and_field!
+        raise CodeGenerator::ScopeNotSpecifiedError if uniqueness[:scope].blank?
+        raise CodeGenerator::FieldNotSpecifiedError if uniqueness[:field].blank?
+        @scoped_class = get_scoped_class
+        @field_name = uniqueness[:field]
+        #TODO - raise an error if field not found for the model. Needs to be indepedent for ActiveRecord & Mongoid.
+      end
+    
+      def generate_unique?
+        uniqueness.present?
+      end
+    
+  end
+end

data/lib/code_generator/version.rb

@@ -0,0 +1,5 @@
+module CodeGenerator
+  
+  VERSION = "0.0.2".freeze
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -16,8 +16,17 @@ email: bindassbharat311@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: http://vinsol.com
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- code_generator.gemspec
+- lib/code_generator.rb
+- lib/code_generator/configure.rb
+- lib/code_generator/generator.rb
+- lib/code_generator/version.rb
+homepage: https://github.com/Bharat311/code_generator
 licenses: []
 post_install_message: 
 rdoc_options: []