egg_carton 0.1

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    egg_carton (0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    growl (1.0.3)
+    guard (0.10.0)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.10)
+      guard (>= 0.8.4)
+    rake (0.9.2.2)
+    rb-fsevent (0.4.3.1)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  egg_carton!
+  growl
+  guard-rspec
+  rake
+  rb-fsevent
+  rspec (~> 2.8)

data/Guardfile

@@ -0,0 +1,4 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/egg_carton/(.+)\.rb}) { |m| "spec/egg_carton/#{m[1]}_spec.rb" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Brandon Hilkert
+
+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,52 @@
+Egg Carton Gem
+=======================
+
+Egg Carton is a series of Ruby number helpers to help with reporting conversions and click-throughs.
+
+Don't put all your eggs in one basket...
+
+Usage
+-----
+
+`gem install egg_carton`
+
+
+Helpers
+-------
+
+The helper methods use a pre-calculate numberator and denominator with the goal of calculating an average or conversion. 
+In many cases, counts are pulled from a database and then need to be displayed properly for reporting. These methods help with 
+the display portion once the values have been calculated.
+
+In Rails, helper methods are added to `ActionView::Base`, and as a result, available to views.
+
+__Average Method__
+
+`average(1, 4)`
+
+`# => 0.25`
+
+`average(1, 4, 1)`
+
+`# => 0.3`
+
+__Conversion Method__
+
+`conversion(1, 4, 2)`
+
+`# => "25%"`
+
+`conversion(1, 4, 2, :percentage => false)`
+
+`# => 0.25`
+
+`conversion(1, 4, 1)`
+
+`# => "30%"`
+
+`conversion(1, 4, 1, :percentage => false)`
+
+`# => 0.3`
+  
+Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).
+

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/egg_carton.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "egg_carton/version"
+
+Gem::Specification.new do |s|
+  s.name        = "egg_carton"
+  s.version     = EggCarton::VERSION
+  s.authors     = ["Brandon Hilkert"]
+  s.email       = ["brandonhilkert@gmail.com"]
+  s.homepage    = "https://github.com/brandonhilkert/egg_carton"
+  s.summary     = %q{Egg Carton Format Helpers}
+  s.description = %q{Egg Carton is a series of Ruby number helpers to help with reporting conversions and click-throughs.}
+
+  s.rubyforge_project = "egg_carton"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 2.8"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "growl"
+  s.add_development_dependency "rake"
+  if RUBY_PLATFORM =~ /darwin/i
+    s.add_development_dependency 'rb-fsevent'
+    s.add_development_dependency 'growl'
+  end
+end

data/lib/egg_carton.rb

@@ -0,0 +1,6 @@
+require "egg_carton/version"
+require "egg_carton/helper"
+require "egg_carton/railtie" if defined?(Rails)
+
+module EggCarton
+end

data/lib/egg_carton/helper.rb

@@ -0,0 +1,60 @@
+module EggCarton
+
+  module Helper
+
+    # Public: Calculates average for a numerator and denominator.
+    #
+    # numberator  - The Integer or Float to use as the numberator.
+    # denominator - The Integer or Float to use as the denominator.
+    # precision - The Integer or decimal places to preserve.
+    #
+    # Examples
+    #
+    #   average(1, 4, 2)
+    #   # => 0.25
+    #
+    #   average(1, 4, 1)
+    #   # => 0.3
+    #
+    # Returns the Float result of the calculation
+    def average(numerator, denominator, precision = 0)
+      return 0 if denominator.zero?
+      (numerator.to_f / denominator.to_f).round(precision)
+    end
+
+    # Public: Calculates conversion for a numerator and denominator.
+    #
+    # numberator  - The Integer or Float to use as the numberator.
+    # denominator - The Integer or Float to use as the denominator.
+    # precision - The Integer or decimal places to preserve.
+    # opts - The options Hash
+    #
+    # Examples
+    #
+    #   conversion(1, 4, 2)
+    #   # => "25%"
+    #
+    #   conversion(1, 4, 2, :percentage => false)
+    #   # => "0.25"
+    #
+    #   conversion(1, 4, 1)
+    #   # => "30%"
+    #
+    #   conversion(1, 4, 1, :percentage => false)
+    #   # => "0.3"
+    #
+    # Returns the Float result of the calculation
+    def conversion(numerator, denominator, precision = 0, opts={})
+      return 0 if denominator.zero?
+      as_percentage = opts[:percentage].nil? ? true : opts[:percentage]
+
+      if as_percentage
+        result = (numerator.to_f / denominator.to_f * 100).round(precision)
+        "#{result}%"
+      else
+        result = (numerator.to_f / denominator.to_f).round(precision)
+        "#{result}"
+      end
+    end
+  end
+end

data/lib/egg_carton/railtie.rb

@@ -0,0 +1,9 @@
+require "rails"
+
+module EggCarton
+  class Railtie < Rails::Railtie
+    initializer "egg_carton.helper" do
+      ActionView::Base.send :include, Helper
+    end
+  end
+end

data/lib/egg_carton/version.rb

@@ -0,0 +1,3 @@
+module EggCarton
+  VERSION = "0.1"
+end

data/spec/egg_carton/helper_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+class Test
+  include EggCarton::Helper
+end
+
+module EggCarton
+
+  describe "Helper" do
+    let(:test) { Test.new }
+
+    describe "#average" do
+      it "should return 4" do
+        test.average(40, 10).should == 4
+      end
+
+      it "should return 4.0" do
+        test.average(40, 10, 1).should == 4.0
+      end
+
+      it "should return 0 if denominator is 0" do
+        test.average(10, 0).should == 0
+      end
+    end
+
+    describe "#conversion" do
+      it "should return 20%" do
+        test.conversion(2, 4).should == "50%"
+      end
+
+      it "should return 20.0%" do
+        test.conversion(2, 4, 1).should == "50.0%"
+      end
+
+      it "should return 0 if denominator is 0" do
+        test.conversion(10, 0).should == 0
+      end
+
+      it "should not calculate percentage" do
+        test.conversion(2, 4, 4, :percentage => false).should_not include("%")
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'egg_carton'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: egg_carton
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Hilkert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70318430644820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *70318430644820
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70318430674600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70318430674600
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70318430674140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70318430674140
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70318430673720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70318430673720
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70318430673260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70318430673260
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70318430672840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70318430672840
+description: Egg Carton is a series of Ruby number helpers to help with reporting
+  conversions and click-throughs.
+email:
+- brandonhilkert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- egg_carton.gemspec
+- lib/egg_carton.rb
+- lib/egg_carton/helper.rb
+- lib/egg_carton/railtie.rb
+- lib/egg_carton/version.rb
+- spec/egg_carton/helper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/brandonhilkert/egg_carton
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: egg_carton
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Egg Carton Format Helpers
+test_files:
+- spec/egg_carton/helper_spec.rb
+- spec/spec_helper.rb