vangogh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80adbf0ea988235079c45eadfedd8665363c1736
+  data.tar.gz: 58f370396da56f00f2f1c618831df14b6fbdd71c
+SHA512:
+  metadata.gz: 9922f54a815b3a48f3a88a6c693e18eac872e3eacaaa37efb70148348fd075ea3843db64fad6339f2691a554ba817f7ea5aa8a541557937e1933614808153595
+  data.tar.gz: b77ca744bde7b0fba3f889f37441cdd3a31fbcaf05ccdea6fb49c7a5a856f759234616d61d3de0660f18d49297e5dd536ccfeea2e2cd2f63b702bdfa6e535f36

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ben Balter
+
+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,51 @@
+# Vangogh
+
+A Ruby Gem for abstracting numbers
+
+## Usage
+
+```Ruby
+# Abstract numbers
+Vangogh.abstract 1234
+=> 1200
+
+Vangogh.abstract 12345
+=> 12000
+
+# Abstract and abbreviate
+Vangogh.abbrevaite 1234
+=> "1.2k"
+
+Vangogh.abbreviate 12345
+=> "12.3k"
+```
+
+You can also extend the numbers themselves, if you prefer:
+
+```ruby
+require 'vangogh/ext'
+
+1234.abstract
+=> 1200
+
+12345.abbreviate
+"12.3k"
+```
+
+Heck, you can even use it via command line:
+
+```
+$ vangogh abstract 1234
+1200
+
+$ vangogh abbreviate 12345
+12.3k
+``
+
+## Contributing
+
+1. Fork it ( https://github.com/benbalter/vangogh/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,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require_relative './lib/vangogh'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["--order", "rand", "--color"]
+end

data/bin/vangogh

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require_relative "../lib/vangogh"
+require 'thor'
+
+class VangoghCli < Thor
+  desc "abstract VALUE", "Abstract the given value (e.g., 1234 -> 1200)"
+  def abstract(value)
+    puts Vangogh.abstract(value.to_f)
+  end
+
+  desc "abbreviate VALUE", "Abbreviate the given value (e.g., 1234 -> 1.2k)"
+  def abbreviate(value)
+    puts Vangogh.abbreviate(value.to_f)
+  end
+end
+
+VangoghCli.start

data/lib/vangogh.rb

@@ -0,0 +1,15 @@
+require_relative "vangogh/version"
+require_relative "vangogh/number"
+require 'si/minimal'
+
+module Vangogh
+  class << self
+    def abstract(value)
+      Number.new(value).abstract
+    end
+
+    def abbreviate(value)
+      Number.new(value).abbreviate
+    end
+  end
+end

data/lib/vangogh/ext.rb

@@ -0,0 +1,9 @@
+class Numeric
+  def abstract
+    Vangogh.abstract(self)
+  end
+
+  def abbreviate
+    Vangogh.abbreviate(self)
+  end
+end

data/lib/vangogh/number.rb

@@ -0,0 +1,38 @@
+module Vangogh
+  class Number
+
+    attr_accessor :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def abstract
+      value.round(1 - abstracted_digits)
+    end
+
+    def abbreviate
+      SI.convert(abstract).sub(/0+([a-z])/i, "\\1").sub(/\.([a-z])/i, "\\1")
+    end
+
+    private
+
+    def digits
+      value.to_i.to_s.length
+    end
+
+    def abstracted_digits
+      if digits <= 4
+        3
+      elsif digits <= 6
+        4
+      elsif digits <= 7
+        5
+      elsif digits <= 8
+        6
+      elsif digits > 8
+        7
+      end
+    end
+  end
+end

data/lib/vangogh/version.rb

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

data/script/bootstrap

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle install

data/script/cibuild

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -e
+
+bundle exec rake spec
+gem build vangogh.gemspec

data/script/console

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle exec pry -r ./lib/vangogh.rb

data/script/release

@@ -0,0 +1,38 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Build a new gem archive.
+
+rm -rf vangogh-*.gem
+gem build -q vangogh.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls vangogh-*.gem | sed 's/^vangogh-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push vangogh-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

data/spec/helper.rb

@@ -0,0 +1,2 @@
+require "bundler/setup"
+require_relative "../lib/vangogh"

data/spec/vangogh_bin_spec.rb

@@ -0,0 +1,11 @@
+require_relative "helper"
+
+describe "Vangogh::Bin" do
+  it "abstracts values" do
+    expect(`bundle exec vangogh abstract 1234`.strip).to eql("1200")
+  end
+
+  it "abbreviates values" do
+    expect(`bundle exec vangogh abbreviate 1234`.strip).to eql("1.2k")
+  end
+end

data/spec/vangogh_ext_spec.rb

@@ -0,0 +1,14 @@
+require_relative "helper"
+require "vangogh/ext"
+
+describe "Vangogh::Ext" do
+  it "extends integers" do
+    expect(1234.abstract).to eql(1200)
+    expect(1234.abbreviate).to eql("1.2k")
+  end
+
+  it "extends floats" do
+    expect(1234.56.abstract).to eql(1200)
+    expect(1234.56.abbreviate).to eql("1.2k")
+  end
+end

data/spec/vangogh_number_spec.rb

@@ -0,0 +1,62 @@
+require_relative "helper"
+
+describe Vangogh::Number do
+
+  subject { Vangogh::Number.new(1234) }
+
+  it "stores the value" do
+    expect(subject.value).to eql(1234)
+  end
+
+  it "knows the number of digits" do
+    expect(subject.send(:digits)).to eql(4)
+  end
+
+  it "handles numbers less than 10" do
+    number = Vangogh::Number.new(1)
+    expect(number.abstract).to eql(0)
+    expect(number.abbreviate).to eql("0")
+  end
+
+  it "handles numbers less than 100" do
+    number = Vangogh::Number.new(12)
+    expect(number.abstract).to eql(0)
+    expect(number.abbreviate).to eql("0")
+  end
+
+  it "handles numbers less than 1000" do
+    number = Vangogh::Number.new(123)
+    expect(number.abstract).to eql(100)
+    expect(number.abbreviate).to eql("100")
+  end
+
+  it "handles numbers less than 10,000" do
+    number = Vangogh::Number.new(1234)
+    expect(number.abstract).to eql(1200)
+    expect(number.abbreviate).to eql("1.2k")
+  end
+
+  it "handles numbers less than 100,000" do
+    number = Vangogh::Number.new(12345)
+    expect(number.abstract).to eql(12000)
+    expect(number.abbreviate).to eql("12k")
+  end
+
+  it "handles numbers less than 1,000,000" do
+    number = Vangogh::Number.new(123456)
+    expect(number.abstract).to eql(123000)
+    expect(number.abbreviate).to eql("123k")
+  end
+
+  it "handles numbers less than 1,000,000" do
+    number = Vangogh::Number.new(1234567)
+    expect(number.abstract).to eql(1230000)
+    expect(number.abbreviate).to eql("1.23M")
+  end
+
+  it "handles numbers greater than 1,000,000" do
+    number = Vangogh::Number.new(12345678)
+    expect(number.abstract).to eql(12300000)
+    expect(number.abbreviate).to eql("12.3M")
+  end
+end

data/spec/vangogh_spec.rb

@@ -0,0 +1,11 @@
+require_relative 'helper'
+
+describe Vangogh do
+  it "abstracts numbers" do
+    expect(subject.abstract(1234)).to eql(1200)
+  end
+
+  it "abbreviates numbers" do
+    expect(subject.abbreviate(1234)).to eql("1.2k")
+  end
+end

data/vangogh.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vangogh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vangogh"
+  spec.version       = Vangogh::VERSION
+  spec.authors       = ["Ben Balter"]
+  spec.email         = ["ben.balter@github.com"]
+  spec.summary       = "A Ruby Gem for abstracting numbers"
+  spec.homepage      = "https://github.com/benbalter/vangogh"
+  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_dependency "si"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: vangogh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: si
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ben.balter@github.com
+executables:
+- vangogh
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/vangogh
+- lib/vangogh.rb
+- lib/vangogh/ext.rb
+- lib/vangogh/number.rb
+- lib/vangogh/version.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/release
+- spec/helper.rb
+- spec/vangogh_bin_spec.rb
+- spec/vangogh_ext_spec.rb
+- spec/vangogh_number_spec.rb
+- spec/vangogh_spec.rb
+- vangogh.gemspec
+homepage: https://github.com/benbalter/vangogh
+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.3
+signing_key: 
+specification_version: 4
+summary: A Ruby Gem for abstracting numbers
+test_files:
+- spec/helper.rb
+- spec/vangogh_bin_spec.rb
+- spec/vangogh_ext_spec.rb
+- spec/vangogh_number_spec.rb
+- spec/vangogh_spec.rb