percentable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a86a351aaeedff408bbab5f914b294f8a898f4a0
+  data.tar.gz: 99d9e1bb82f6ff9e5f9242518240d113f5c9f31f
+SHA512:
+  metadata.gz: 304b7c8663f0b5a6764d0e9b6739765d054c1a768a9247b20fa65d1e108e66405e9338f26f74213ac2eb39c03d42e4a7664f9d700cb60eca6175ee2833f9356d
+  data.tar.gz: b8323fc3c48aa7b7a1e448bea8694bbc23b3bea7a9c2fb206e4b52121b6aad1b2bba554a9c441dfc93291b10512f908ecad1649447e433d9eb28765d3c47ab8e

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in percentable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric Roberts
+
+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,114 @@
+# Percentable
+
+Small gem to make working with percents easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'percentable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install percentable
+
+## Usage
+
+### So how do I use this thing?
+
+Well, you can use this a couple of ways.
+
+``` ruby
+percent = Percent.new(50)
+percent.value   #=> 50.0
+percent.to_s    #=> '50%'
+percent.to_f    #=> 0.5
+percent == 50   #=> false
+percent == 0.5  #=> true
+```
+
+That's the basics of the object itself. You probably want to know about how it works with other percents though, right?
+
+``` ruby
+percent = Percent.new(10)
+percent + percent   #=> Percent.new(20)
+percent - percent   #=> Percent.new(0)
+percent * percent   #=> Percent.new(100)
+percent / percent   #=> Percent.new(1)
+```
+
+And even more importantly, how it works with other Numeric objects:
+
+``` ruby
+percent = Percent.new(50)
+percent + 10    #=> Percent.new(60)
+percent - 10    #=> Percent.new(40)
+percent * 10    #=> Percent.new(500)
+percent / 10    #=> Percent.new(5)
+```
+
+Repeat steps above for Floats, BigDecimals, etc. It should all work.
+
+### Can I turn other Numerics into Percents?
+
+Yes, yes you can.
+
+``` ruby
+10.to_percent   #=> Percent.new(10)
+```
+
+### How do I use this with Rails?
+
+Well let's say you have a User model, and on that user model you have a health attribute. You want to set that to a number that represents the percent. Just use the extend Percentable::Percentize method, and then use the percentize method to make sure you are returned percent objects always. Example below:
+
+``` ruby
+class User < ActiveRecord::Base
+  extend Percentable::Percentize
+
+  percentize :health
+end
+
+user = User.new(health: 100)
+user.health     #=> Percent.new(100)
+```
+
+### What if I don't use Rails but want to use percentize?
+
+That works too, there's nothing Rails specific about `Percentable::Percentize`. Example below:
+
+``` ruby
+class OriginalClass
+  def returns_a_percent
+    10
+  end
+end
+
+class PercentizedClass
+  extend Percentable::Percentize
+
+  percentize :returns_a_percent
+end
+
+percentize_object = PercentizedClass.new
+percentize_object.returns_a_percent     #=> Percent.new(10)
+```
+
+### OK, but why would I want this?
+
+I don't know, all I can tell you is that I found it useful. Instead of writing methods to translate from 0.1 to 10% all over the place, I now have a class to represent everything to do with percents.
+
+### Is that it?
+
+Hey, I only wrote this in a night. Happy to except contributions from others!
+
+## Contributing
+
+1. Fork it ( https://github.com/ericroberts/percentable/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/percentable.rb

@@ -0,0 +1,4 @@
+require_relative 'percentable/version'
+require_relative 'percentable/numeric'
+require_relative 'percentable/percent'
+require_relative 'percentable/percentize'

data/lib/percentable/numeric.rb

@@ -0,0 +1,11 @@
+module Percentable
+  module Numeric
+    def to_percent
+      Percentable::Percent.new(self)
+    end
+  end
+end
+
+class Numeric
+  include Percentable::Numeric
+end

data/lib/percentable/percent.rb

@@ -0,0 +1,82 @@
+module Percentable
+  class Percent < ::Numeric
+    def initialize(value)
+      @value = value.to_f
+    end
+
+    def value
+      @value ||= 0.to_f
+    end
+
+    def to_s
+      '%g%%' % value
+    end
+
+    def to_f
+      value/100
+    end
+
+    def to_i
+      value.to_i
+    end
+
+    def coerce other
+      case other
+      when Numeric
+        [to_f, other]
+      else
+        fail TypeError, "#{self.class} can't be coerced into #{other.class}"
+      end
+    end
+
+    def == other
+      (other.class == self.class && other.value == self.value) || other == self.to_f
+    end
+
+    def eql? other
+      self.send(:==, other)
+    end
+
+    def <=> other
+      to_f <=> other.to_f
+    end
+
+    def + other
+      case other
+      when Percent
+        self.class.new(other.value + value)
+      when Numeric
+        self.class.new(other + value)
+      end
+    end
+
+    def * other
+      case other
+      when Percent
+        self.class.new(other.value * value)
+      when Numeric
+        self.class.new(other * value)
+      end
+    end
+
+    def - other
+      case other
+      when Percent
+        self.class.new(value - other.value)
+      when Numeric
+        self.class.new(value - other)
+      end
+    end
+
+    def / other
+      case other
+      when Percent
+        self.class.new(value / other.value)
+      when Numeric
+        self.class.new(value / other)
+      end
+    end
+  end
+end
+
+Percent = Percentable::Percent

data/lib/percentable/percentize.rb

@@ -0,0 +1,9 @@
+module Percentable
+  module Percentize
+    def percentize field
+      define_method(field) do |args=[]|
+        Percent.new(super(*args))
+      end
+    end
+  end
+end

data/lib/percentable/version.rb

@@ -0,0 +1,3 @@
+module Percentable
+  VERSION = "0.0.1"
+end

data/percentable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'percentable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "percentable"
+  spec.version       = Percentable::VERSION
+  spec.authors       = ["Eric Roberts"]
+  spec.email         = ["ericroberts@gmail.com"]
+  spec.summary       = "Small gem to make working with percents easier."
+  spec.description   = "Small gem to make working with percents easier. Includes methods to make selected rails attributes return percents."
+  spec.homepage      = "https://github.com/ericroberts/percentable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/lib/percentable/numeric_spec.rb

@@ -0,0 +1,20 @@
+require 'percentable/numeric'
+require 'bigdecimal'
+
+describe Numeric do
+  [1, 1.0, BigDecimal.new(1, 10)].each do |numeric|
+    subject { numeric }
+
+    context numeric.class.name do
+      describe '#to_percent' do
+        it 'should respond to it' do
+          expect(subject).to respond_to :to_percent
+        end
+
+        it 'should return the value as percent' do
+          expect(subject.to_percent).to eq Percentable::Percent.new(subject)
+        end
+      end
+    end
+  end
+end

data/spec/lib/percentable/percent_spec.rb

@@ -0,0 +1,235 @@
+require 'percentable/percent'
+
+describe Percentable::Percent do
+  subject { Percentable::Percent.new(value) }
+  let(:value) { nil }
+
+  describe '#initialize' do
+    context 'with value represented as string' do
+      let(:value) { '50%' }
+
+      it 'should have a value of 50' do
+        expect(subject.value).to eq 50
+      end
+    end
+  end
+
+  describe '#to_s' do
+    context 'with value of 50' do
+      let(:value) { 50 }
+
+      it 'should return 50%' do
+        expect(subject.to_s).to eq '50%'
+      end
+    end
+
+    context 'with value of 0.025' do
+      let(:value) { 0.025 }
+
+      it 'should return 0.025%' do
+        expect(subject.to_s).to eq '0.025%'
+      end
+    end
+  end
+
+  describe '#to_f' do
+    context 'with value of 50' do
+      let(:value) { 50 }
+
+      it 'should return 0.5' do
+        expect(subject.to_f).to eq 0.5
+      end
+    end
+
+    context 'with value of 10.5' do
+      let(:value) { 10.5 }
+
+      it 'should return 0.105' do
+        expect(subject.to_f).to eq 0.105
+      end
+    end
+  end
+
+  describe '#zero?' do
+    context 'with value of 0' do
+      let(:value) { 0 }
+
+      it 'should return true' do
+        expect(subject.zero?).to be true
+      end
+    end
+
+    context 'with any other value' do
+      let(:value) { 10 }
+
+      it 'should return false' do
+        expect(subject.zero?).to be false
+      end
+    end
+  end
+
+  shared_examples 'it is equal' do |equal_method|
+    it 'should consider itself equal to other percents with the same value' do
+      percent1 = subject.class.new(50)
+      percent2 = subject.class.new(50)
+
+      expect(percent1.send(equal_method, percent2)).to be true
+    end
+
+    it 'should consider itself equal to a float matching the float value' do
+      float = 0.015
+      percent = subject.class.new(float*100)
+
+      expect(percent.send(equal_method, float)).to be true
+    end
+
+    it 'should consider itself equal to an integer matching the float value' do
+      integer = 2
+      percent = subject.class.new(integer*100)
+
+      expect(percent.send(equal_method, integer)).to be true
+    end
+  end
+
+  describe '#==' do
+    it_should_behave_like 'it is equal', :==
+  end
+
+  describe '#eql?' do
+    it_should_behave_like 'it is equal', :eql?
+  end
+
+  describe '#+' do
+    context 'adding percents' do
+      let(:percent1) { subject.class.new(50) }
+      let(:percent2) { subject.class.new(50) }
+
+      it 'should return the sum of both percents' do
+        expect(percent1 + percent2).to eq subject.class.new(100)
+      end
+    end
+
+    context 'adding integers' do
+      let(:integer) { 1 }
+      let(:percent) { subject.class.new(50) }
+
+      it 'should return the sum of percent and integer' do
+        expect(percent + integer).to eq subject.class.new(51)
+      end
+    end
+
+    context 'adding floats' do
+      let(:float) { 1.0 }
+      let(:percent) { subject.class.new(25) }
+
+      it 'should return the sum of percent and float' do
+        expect(percent + float).to eq subject.class.new(26)
+      end
+    end
+  end
+
+  describe '#-' do
+    context 'subtracting percents' do
+      let(:percent1) { subject.class.new(50) }
+      let(:percent2) { subject.class.new(10) }
+
+      it 'should return the result after subtraction' do
+        expect(percent1 - percent2).to eq subject.class.new(40)
+      end
+    end
+
+    context 'subtracting other numerics' do
+      let(:value) { 20 }
+
+      [1, 1.0, BigDecimal.new(1.0, 10)].each do |numeric|
+        context numeric.class.name do
+          it "should return the result after subtracting the #{numeric.class.name} from the percent" do
+            expect(subject - numeric).to eq subject.class.new(19)
+          end
+        end
+      end
+    end
+  end
+
+  describe '#*' do
+    context 'multiplying percents' do
+      let(:percent1) { subject.class.new(9) }
+      let(:percent2) { subject.class.new(9) }
+
+      it 'should return the result of multiplying the percents' do
+        expect(percent1 * percent2).to eq subject.class.new(81)
+      end
+    end
+
+    context 'multiplying other numerics' do
+      let(:numeric) { 2 }
+      let(:percent) { subject.class.new(20) }
+
+      it 'should return the result of multipling the percent by the number' do
+        expect(percent * numeric).to eq subject.class.new(40)
+      end
+    end
+  end
+
+  describe '#/' do
+    context 'dividing percents' do
+      let(:percent1) { subject.class.new(50) }
+      let(:percent2) { subject.class.new(10) }
+
+      it 'should return the result after division' do
+        expect(percent1 / percent2).to eq subject.class.new(5)
+      end
+    end
+
+    context 'dividing other numerics' do
+      let(:value) { 20 }
+
+      [5, 5.0, BigDecimal.new(5.0, 10)].each do |numeric|
+        context numeric.class.name do
+          it "should return the result after subtracting the #{numeric.class.name} from the percent" do
+            expect(subject / numeric).to eq subject.class.new(4)
+          end
+        end
+      end
+    end
+  end
+
+  describe 'comparable' do
+    it 'is comparable' do
+      expect(Comparable === subject).to be true
+    end
+
+    context 'compared to other percents' do
+      let(:larger_percent) { subject.class.new(100) }
+      let(:smaller_percent) { subject.class.new(50) }
+
+      it 'should be able to tell when things are larger' do
+        expect(larger_percent > smaller_percent).to be true
+      end
+
+      it 'should be able to tell when things are smaller' do
+        expect(smaller_percent < larger_percent).to be true
+      end
+    end
+
+    context 'compared to integers' do
+      context 'when integer is larger' do
+        let(:integer) { 30 }
+        let(:percent) { subject.class.new(10) }
+
+        it 'should say the percent is smaller' do
+          expect(percent < integer).to be true
+        end
+      end
+
+      context 'when integer is smaller' do
+        let(:integer) { 1 }
+        let(:percent) { subject.class.new(101) }
+
+        it 'should say the percent is larger' do
+          expect(percent > integer).to be true
+        end
+      end
+    end
+  end
+end

data/spec/lib/percentable/percentize_spec.rb

@@ -0,0 +1,22 @@
+require 'percentable/percent'
+require 'percentable/percentize'
+
+class TestClass
+  def returns_a_percent
+    10
+  end
+end
+
+class Subject < TestClass
+  extend Percentable::Percentize
+
+  percentize :returns_a_percent
+end
+
+describe Percentable::Percentize do
+  subject { Subject.new }
+
+  it 'should return a percent with value of TestClass' do
+    expect(subject.returns_a_percent).to eq Percentable::Percent.new(10)
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: percentable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Small gem to make working with percents easier. Includes methods to make
+  selected rails attributes return percents.
+email:
+- ericroberts@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/percentable.rb
+- lib/percentable/numeric.rb
+- lib/percentable/percent.rb
+- lib/percentable/percentize.rb
+- lib/percentable/version.rb
+- percentable.gemspec
+- spec/lib/percentable/numeric_spec.rb
+- spec/lib/percentable/percent_spec.rb
+- spec/lib/percentable/percentize_spec.rb
+homepage: https://github.com/ericroberts/percentable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Small gem to make working with percents easier.
+test_files:
+- spec/lib/percentable/numeric_spec.rb
+- spec/lib/percentable/percent_spec.rb
+- spec/lib/percentable/percentize_spec.rb