percent 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ba54ea6f9cd4071338360bee6e073c87710f6f9
+  data.tar.gz: 14d795b2df55dfa1ed3eb4629061b68b533878cd
+SHA512:
+  metadata.gz: 4924d7c67df23882936c2a1a5a2c3687128bf6b71c138d9ce6c6021a201916f000b5e0e930acf7b78f674e6ea914ce1e2822fdf79796699eaeff369e6c3f1b9d
+  data.tar.gz: 17bc724e07383b35fb7c6c8f8372ddfbad765a850762cf855b31b860cd27897f55428b5d77fd2f5425c6c7bf225065626ec686e7e784f4d8a925514dc5611c89

data/lib/percent.rb

@@ -0,0 +1,9 @@
+require 'percentage'
+require 'percent/hooks'
+
+module Percent
+end
+
+if defined? Rails
+  require 'percent/railtie'
+end

data/lib/percent/active_model/percentage_validator.rb

@@ -0,0 +1,11 @@
+module Percent
+  module ActiveModel
+    class PercentageValidator < ::ActiveModel::Validations::NumericalityValidator
+      def validate_each(record, attr, value)
+        super record, attr, (value.nil? ? value : value.to_decimal)
+      end
+    end
+  end
+end
+
+ActiveModel::Validations::PercentageValidator = Percent::ActiveModel::PercentageValidator

data/lib/percent/active_record/migration_extensions/options.rb

@@ -0,0 +1,21 @@
+module Percent
+  module ActiveRecord
+    module MigrationExtensions
+      module Options
+        def self.without_table(accessor, options = {})
+          column_name = accessor.to_s + '_fraction'
+          options[:null] ||= false
+          options[:default] ||= 0
+          type = :decimal
+
+          [column_name, type, options]
+        end
+
+        def self.with_table(table_name, accessor, options = {})
+          options = self.without_table accessor, options
+          options.unshift table_name
+        end
+      end
+    end
+  end
+end

data/lib/percent/active_record/migration_extensions/schema_statements.rb

@@ -0,0 +1,18 @@
+module Percent
+  module ActiveRecord
+    module MigrationExtensions
+      module SchemaStatements
+        def add_percentage(table_name, accessor, options={})
+          *opts = Options.with_table table_name, accessor, options
+          add_column *opts
+        end
+
+        def remove_percentage(table_name, accessor, options={})
+          *opts = Options.with_table table_name, accessor, options
+          remove_column *opts
+        end
+      end
+    end
+  end
+end
+

data/lib/percent/active_record/migration_extensions/table.rb

@@ -0,0 +1,18 @@
+module Percent
+  module ActiveRecord
+    module MigrationExtensions
+      module Table
+        def percentage(accessor, options={})
+          *opts = Options.without_table accessor, options
+          column *opts
+        end
+
+        def remove_percentage(accessor, options={})
+          *opts = Options.without_table accessor, options
+          remove *opts
+        end
+      end
+    end
+  end
+end
+

data/lib/percent/active_record/percentizable.rb

@@ -0,0 +1,71 @@
+module Percent
+  module ActiveRecord
+    module Percentizable
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def percentize(*columns)
+          # initialize options
+          options = columns.extract_options!
+
+          columns.each do |column|
+            column_name = column.to_s
+
+            # determine attribute name
+            if options[:as]
+              attribute_name = options[:as]
+            elsif column_name =~ /_fraction$/
+              attribute_name = column_name.sub /_fraction$/, ""
+            else
+              attribute_name = column_name + '_percent'
+            end
+
+            # validation
+            unless options[:disable_validation]
+              allow_nil = options.fetch :allow_nil, false
+              numericality = options[:numericality]
+              fraction = options[:fraction_numericality]
+
+              if numericality || !options.key?(:numericality)
+                numericality = numericality_range 0, 100 unless fraction.is_a? Hash
+
+                validates attribute_name, {
+                  allow_nil: allow_nil,
+                  'percent/active_model/percentage': numericality
+                }
+              end
+
+              if fraction || !options.key?(:fraction_numericality)
+                unless numericality.is_a?(Hash) && options.key?(:numericality)
+                  fraction = numericality_range 0, 1
+                end
+
+                validates column_name, allow_nil: allow_nil, numericality: fraction
+              end
+            end
+
+            # percent attribute getter
+            define_method attribute_name do
+              value = public_send column_name
+              value.nil? ? value : Percentage.from_fraction(value, options)
+            end
+
+            # percent attribute setter
+            define_method "#{attribute_name}=" do |value|
+              unless value.nil? || value.is_a?(Percentage)
+                value = Percentage.from_amount value, options
+              end
+              public_send "#{column_name}=", (value.nil? ? value : value.to_d)
+            end
+          end
+        end
+
+      private 
+
+        def numericality_range(min, max)
+          { greater_than_or_equal_to: min, less_than_or_equal_to: max }
+        end
+      end
+    end
+  end
+end

data/lib/percent/hooks.rb

@@ -0,0 +1,18 @@
+module Percent
+  class Hooks
+    def self.init
+      ActiveSupport.on_load(:active_record) do
+        require 'percent/active_model/percentage_validator'
+        require 'percent/active_record/percentizable'
+        ::ActiveRecord::Base.send :include, Percent::ActiveRecord::Percentizable
+
+        require 'percent/active_record/migration_extensions/options'
+        require 'percent/active_record/migration_extensions/schema_statements'
+        require 'percent/active_record/migration_extensions/table'
+        ::ActiveRecord::Migration.send :include, Percent::ActiveRecord::MigrationExtensions::SchemaStatements
+        ::ActiveRecord::ConnectionAdapters::TableDefinition.send :include, Percent::ActiveRecord::MigrationExtensions::Table
+        ::ActiveRecord::ConnectionAdapters::Table.send :include, Percent::ActiveRecord::MigrationExtensions::Table
+      end
+    end
+  end
+end

data/lib/percent/railtie.rb

@@ -0,0 +1,7 @@
+module Percent
+  class Railtie < ::Rails::Railtie
+    initializer 'percent.initialize' do
+      Percent::Hooks.init
+    end
+  end
+end

data/lib/percentage.rb

@@ -0,0 +1,127 @@
+require 'bigdecimal'
+require 'bigdecimal/util'
+
+class Percentage < Numeric
+  def initialize(val = 0, options = {})
+    val = 0.0            if !val
+    val = 1.0            if val == true
+    val = val.to_r       if val.is_a?(String) && val['/']
+    val = val.to_f       if val.is_a?(Complex) || val.is_a?(Rational)
+    val = val.to_i       if val.is_a?(String) && !val['.']
+    val = val.to_d / 100 if val.is_a?(Integer) || (val.is_a?(String) && val['%'])
+    val = val.value      if val.is_a? self.class
+
+    @value = val.to_d
+  end
+
+  ###
+  # Attributes
+  ###
+  def value
+    @value ||= 0
+  end
+
+  ###
+  # Convert percentage to different number formats
+  ###
+  def to_i; (self.value * 100).to_i; end
+  def to_c; self.value.to_c; end
+  def to_d; self.value.to_d; end
+  def to_f; self.value.to_f; end
+  def to_r; self.value.to_r; end
+
+  ###
+  # Convert percentage fraction to percent amount
+  ###
+  def to_complex;  (self.value * 100).to_c; end
+  def to_decimal;  (self.value * 100).to_d; end
+  def to_float;    (self.value * 100).to_f; end
+  def to_rational; (self.value * 100).to_r; end
+
+  ###
+  # String conversion methods
+  ###
+  def to_s;      self.to_amount.to_s; end
+  def to_str;    self.to_f.to_s;      end
+  def to_string; self.to_s + '%';     end
+
+  def format(options = {})
+    # set defaults; all other options default to false
+    options[:percent_sign] = options.fetch :percent_sign, true
+
+    if options[:as_decimal]
+      return self.to_str
+    elsif options[:rounded]
+      string = self.to_float.round.to_s
+    elsif options[:no_decimal]
+      string = self.to_i.to_s
+    elsif options[:no_decimal_if_whole]
+      string = self.to_s
+    else
+      string = self.to_float.to_s
+    end
+
+    string += ' ' if options[:space_before_sign]
+    string += '%' if options[:percent_sign]
+    return string
+  end
+
+  ###
+  # Additional conversion methods
+  ###
+  def to_amount
+    (int = self.to_i) == (float = self.to_float) ? int : float
+  end
+
+  def inspect
+    "#<#{self.class.name}:#{self.object_id}, #{self.value.inspect}>"
+  end
+
+  ###
+  # Comparisons
+  ###
+  def == other
+    self.eql?(other) || self.to_f == other
+  end
+
+  def eql? other
+    self.class == other.class && self.value == other.value
+  end
+
+  def <=> other
+    self.to_f <=> other.to_f
+  end
+
+  ###
+  # Mathematical operations
+  ###
+  [:+, :-, :/, :*].each do |operator|
+    define_method operator do |other|
+      case other
+      when Percentage
+        new_value = self.value.public_send(operator, other.value)
+        self.class.new new_value
+      else
+        self.value.to_f.public_send(operator, other)
+      end
+    end
+  end
+
+  ###
+  # Additional initialization methods
+  ###
+  def self.from_fraction(val = 0, options = {})
+    val = val.to_i if val.is_a?(String) && !(val['/'] || val['%'] || val['.'])
+    val = val.to_d if val.is_a?(Integer)
+
+    self.new val, options
+  end
+
+  def self.from_amount(val = 0, options = {})
+    val = val.to_r  if val.is_a?(String) && val['/']
+    val = val.to_d  if val.is_a?(String)
+    val = val / 100 if val.is_a?(Numeric) && !val.integer?
+
+    self.new val, options
+  end
+end

data/percent.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name     = 'percent'
+  s.version  = '0.0.1'
+  s.platform = Gem::Platform::RUBY
+  s.license  = 'MIT'
+  s.authors  = ['Joe Kennedy']
+  s.email    = ['joseph.stephen.kennedy@gmail.com']
+  s.summary  = 'Percent objects and integration with Rails'
+  s.homepage = 'https://github.com/JoeKennedy/percent'
+
+  s.files = Dir.glob('{lib,spec}/**/*') + %w(percent.gemspec)
+  s.files.delete 'spec/percent.sqlite3'
+
+  s.test_files   = s.files.grep(%r{^spec/})
+
+  s.require_path = 'lib'
+
+  s.add_dependency 'activesupport', '~> 4.2'
+
+  s.add_development_dependency 'activerecord', '~> 4.2'
+  s.add_development_dependency 'bundler',      '~> 1.11'
+  s.add_development_dependency 'rake',         '~> 10'
+  s.add_development_dependency 'rspec',        '~> 3.0'
+  s.add_development_dependency 'sqlite3',      '~> 1.3'
+end

data/spec/lib/percent/active_record/migration_extensions/schema_statements_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+class JobTracker < ActiveRecord::Base; end
+
+if defined? ActiveRecord
+  describe Percent::ActiveRecord::MigrationExtensions::SchemaStatements do
+    before :all do
+      @connection = ActiveRecord::Base.connection
+      @connection.send :extend, Percent::ActiveRecord::MigrationExtensions::SchemaStatements
+
+      @connection.drop_table :job_trackers if @connection.table_exists? :job_trackers
+      @connection.create_table :job_trackers
+
+      @options = { default: 1, null: true }
+
+      @connection.add_percentage :job_trackers, :percentage
+      @connection.add_percentage :job_trackers, :full_options, @options
+
+      JobTracker.reset_column_information
+    end
+
+    describe '#add_percentage' do
+      context 'default options' do
+        subject { JobTracker.columns_hash['percentage_fraction'] }
+
+        it 'should default to 0' do
+          expect(subject.default).to eql '0'
+          expect(JobTracker.new.public_send subject.name).to eql 0
+        end
+
+        it 'should not allow null values' do
+          expect(subject.null).to be false
+        end
+
+        it 'should be of type decimal' do
+          expect(subject.type).to eql :decimal
+        end
+      end
+
+      context 'full options' do
+        subject { JobTracker.columns_hash['full_options_fraction'] }
+
+        it 'should default to 1' do
+          expect(subject.default).to eql '1'
+          expect(JobTracker.new.public_send subject.name).to eql 1
+        end
+
+        it 'should allow null values' do
+          expect(subject.null).to be true
+        end
+
+        it 'should be of type decimal' do
+          expect(subject.type).to eql :decimal
+        end
+      end
+    end
+
+    describe '#remove_percentage' do
+      before :all do
+        @connection.remove_percentage :job_trackers, :percentage
+        @connection.remove_percentage :job_trackers, :full_options, @options
+
+        JobTracker.reset_column_information
+      end
+
+      it 'should remove percentage columns' do
+        expect(JobTracker.columns_hash['percentage_fraction']).to be nil
+        expect(JobTracker.columns_hash['full_options_fraction']).to be nil
+      end
+    end
+
+  end
+end

data/spec/lib/percent/active_record/migration_extensions/table_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+class JobTracker < ActiveRecord::Base; end
+
+if defined? ActiveRecord
+  describe Percent::ActiveRecord::MigrationExtensions::Table do
+    before :all do
+      @connection = ActiveRecord::Base.connection
+      @connection.send :extend, Percent::ActiveRecord::MigrationExtensions::SchemaStatements
+
+      @options = { default: 1, null: true }
+
+      @connection.drop_table :job_trackers if @connection.table_exists? :job_trackers
+      @connection.create_table :job_trackers do |t|
+        t.percentage :percentage
+        t.percentage :full_options, @options
+      end
+
+      JobTracker.reset_column_information
+    end
+
+    describe '#percentage' do
+      context 'default options' do
+        subject { JobTracker.columns_hash['percentage_fraction'] }
+
+        it 'should default to 0' do
+          expect(subject.default).to eql '0'
+          expect(JobTracker.new.public_send subject.name).to eql 0
+        end
+
+        it 'should not allow null values' do
+          expect(subject.null).to be false
+        end
+
+        it 'should be of type decimal' do
+          expect(subject.type).to eql :decimal
+        end
+      end
+
+      context 'full options' do
+        subject { JobTracker.columns_hash['full_options_fraction'] }
+
+        it 'should default to 1' do
+          expect(subject.default).to eql '1'
+          expect(JobTracker.new.public_send subject.name).to eql 1
+        end
+
+        it 'should allow null values' do
+          expect(subject.null).to be true
+        end
+
+        it 'should be of type decimal' do
+          expect(subject.type).to eql :decimal
+        end
+      end
+    end
+
+    describe '#remove_percentage' do
+      before :all do
+        @connection.change_table :job_trackers do |t|
+          t.remove_percentage :percentage
+          t.remove_percentage :full_options, @options
+        end
+
+        JobTracker.reset_column_information
+      end
+
+      it 'should remove percentage columns' do
+        expect(JobTracker.columns_hash['percentage_fraction']).to be nil
+        expect(JobTracker.columns_hash['full_options_fraction']).to be nil
+      end
+    end
+  end
+end