percentise 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [Matthew Rudy Jacobs]
+
+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

@@ -0,0 +1,37 @@
+Percentise
+==========
+
+A single way to produce consistent percentages
+
+Example
+=======
+
+The obvious:
+  >> Percentise(50, 100)
+  => 50.0
+  
+Error cases:
+  >> Percentise(nil, 100)
+  => nil
+  >> Percentise(50, nil)
+  => nil
+  >> Percentise(nil, nil)
+  => nil
+  
+Don't worry about dividing by 0
+
+  >> Percentise(0,0)
+  => 0.0
+  >> Percentise(1,0)
+  => 100.0
+  >> Percentise(-1,0)
+  => -100.0
+  
+Find the % difference 
+
+  >> Percentise.diff(50, 100)
+  => -50.0
+  >> Percentise.diff(100, 50)
+  => 100.0
+  
+Copyright (c) 2010 [Matthew Rudy Jacobs], released under the MIT license

data/Rakefile

@@ -0,0 +1,87 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test Percentise.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for Percentise.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Percentise'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "percentise"
+  s.version           = "0.1.0"
+  s.summary           = "Simple, consistent Percentises"
+  s.author            = "Matthew Rudy Jacobs"
+  s.email             = "MatthewRudyJacobs@gmail.com"
+  s.homepage          = "https://github.com/matthewrudy/percentise"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README)
+  s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(MIT-LICENSE Rakefile README) + Dir.glob("{test,lib}/**/*")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+
+  # If your tests use any gems, include them here
+  # s.add_development_dependency("mocha") # for example
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# If you don't want to generate the .gemspec file, just remove this line. Reasons
+# why you might want to generate a gemspec:
+#  - using bundler with a git source
+#  - building the gem without rake (i.e. gem build blah.gemspec)
+#  - maybe others?
+task :package => :gemspec
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/lib/percentise.rb

@@ -0,0 +1,23 @@
+# Percentise
+module Percentise
+
+  def self.this(top, bottom)
+    if top && bottom
+      if bottom == 0
+        top_sign = top.to_f <=> 0
+        top_sign * 100.0
+      else
+        100.0 * top.to_f / bottom.to_f
+      end
+    end
+  end
+  
+  def self.diff(top, bottom)
+    self.this(top - bottom, bottom)
+  end
+
+end
+
+def Percentise(*args)
+  Percentise.this(*args)
+end

data/test/percentise_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+require 'percentise'
+
+class PercentiseTest < Test::Unit::TestCase
+  
+  test "if top is nil returns nil" do
+    assert_equal nil, Percentise.this(nil, 20)
+  end
+  
+  test "if bottom is nil returns nil" do
+    assert_equal nil, Percentise.this(20, nil)
+  end
+  
+  test "if bottom is zero, and top is > 0, it is 100%" do
+    assert_equal 100.0, Percentise.this(20, 0)
+  end
+  
+  test "if bottom and top are both zero it is 0%" do
+    assert_equal 0.0, Percentise.this(0, 0)
+  end
+  
+  test "if bottom is zero, and top is < 0, it is -100%" do
+    assert_equal -100.0, Percentise.this(-20, 0)
+  end
+  
+  test "Percentise.this" do
+    assert_equal 50.0, Percentise.this(1, 2)
+    assert_in_delta 33.3333, Percentise.this(7, 21), 1E-4
+  end
+  
+  test "Percentise()" do
+    assert_equal 50.0, Percentise(1, 2)
+    assert_in_delta 33.3333, Percentise(7, 21), 1E-4
+  end
+  
+  test "diff" do
+    assert_equal -50.0, Percentise.diff(50, 100)
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support/testing/declarative'
+$: << File.expand_path(File.dirname(__FILE__)+"/../lib")
+
+class Test::Unit::TestCase
+  extend ActiveSupport::Testing::Declarative
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: percentise
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Rudy Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-17 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: MatthewRudyJacobs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- Rakefile
+- README
+- test/percentise_test.rb
+- test/test_helper.rb
+- lib/percentise.rb
+has_rdoc: true
+homepage: https://github.com/matthewrudy/percentise
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple, consistent Percentises
+test_files: []
+