overpunch 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62fbb5c8fc73e0121256c00cda49b226a3476c91
+  data.tar.gz: cb0fdb7e6d14c1837a19e49a37fc0be9168653f1
+SHA512:
+  metadata.gz: 975e157d5b2dae02806efc73a968f632bad7a52f5ea37b2e1a52459a7270083af7de6a689b6790c1836dceb3b84bdf41b75f7fe60301cae4b77f3dd4409e9c91
+  data.tar.gz: e591f471e9078fe9211d67f0c03b524403297c9d34691b1e9ddfad5fa03b7d3e96654b9e3c77cea79ab70e81f69e3b65690bedb8f9ee92693959ffe687fc74c6

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - jruby
+  - 2.0.0
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - john+overpunch@carney.id.au
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Carney
+
+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,75 @@
+# Overpunch
+
+Simple module for parsing and formatting numbers in signed overpunch format.
+
+[Signed overpunch](http://wikipedia.org/wiki/Signed_overpunch) is a code used
+to indicate the sign of a number by replacing the last digit with a signed
+overpunch code. For example, -45 would be encoded as "4N".
+
+| Sign | Digit | Code |
+|:----:|:-----:|:----:|
+|    + |     0 |    { |
+|    + |     1 |    A |
+|    + |     2 |    B |
+|    + |     3 |    C |
+|    + |     4 |    D |
+|    + |     5 |    E |
+|    + |     6 |    F |
+|    + |     7 |    G |
+|    + |     8 |    H |
+|    + |     9 |    I |
+|    - |     0 |    } |
+|    - |     1 |    J |
+|    - |     2 |    K |
+|    - |     3 |    L |
+|    - |     4 |    M |
+|    - |     5 |    N |
+|    - |     6 |    O |
+|    - |     7 |    P |
+|    - |     8 |    Q |
+|    - |     9 |    R |
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'overpunch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install overpunch
+
+## Usage
+
+    require "overpunch"
+
+    Overpunch.parse("032B")
+    # => 322
+
+    Overpunch.parse("1}")
+    # => -10
+
+    Overpunch.format(110)
+    # => "11{"
+
+    Overpunch.format(-272)
+    # => "27K"
+
+    Overpunch.format(20, width: 6)
+    # => "00002{"
+
+## Requirements
+
+* Ruby 2.0.0 or later
+
+## Contributing
+
+1. Fork it ( http://github.com/johncarney/overpunch/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 new Pull Request

data/Rakefile

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

data/lib/overpunch/version.rb

@@ -0,0 +1,3 @@
+module Overpunch
+  VERSION = "1.0.0"
+end

data/lib/overpunch.rb

@@ -0,0 +1,33 @@
+require "overpunch/version"
+
+module Overpunch
+  POS_OVERPUNCH_SET = '{ABCDEFGHI'.freeze
+  NEG_OVERPUNCH_SET = '}JKLMNOPQR'.freeze
+
+  OVERPUNCH_PATTERN = /\A\s*0*(\d*(([#{POS_OVERPUNCH_SET}])|([#{NEG_OVERPUNCH_SET}])))\s*\Z/.freeze
+
+  def self.parse(string)
+    unless matches = string.match(OVERPUNCH_PATTERN)
+      raise ArgumentError, "Invalid overpunch string: \"#{string}\""
+    end
+
+    sign, overpunch_set = if matches[3]
+      [  1, POS_OVERPUNCH_SET ]
+    else
+      [ -1, NEG_OVERPUNCH_SET ]
+    end
+    sign * matches[1].tr(overpunch_set, '0-9').to_i
+  end
+
+  def self.format(number, width: nil)
+    overpunch_set = if number < 0
+      NEG_OVERPUNCH_SET
+    else
+      POS_OVERPUNCH_SET
+    end
+    abs_number = number.abs
+    formatted = abs_number.to_s[0..-2] + overpunch_set[abs_number % 10]
+    padding = [ (width || 0) - formatted.size, 0 ].max
+    ("0" * padding) + formatted
+  end
+end

data/overpunch.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'overpunch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "overpunch"
+  spec.version       = Overpunch::VERSION
+  spec.authors       = ["John Carney"]
+  spec.email         = ["john@carney.id.au"]
+  spec.summary       = %q{Parses and formats numbers in signed overpunch format.}
+  spec.description   = %q{Simple module for parsing and formatting numbers in signed overpunch format.}
+  spec.homepage      = "https://github.com/johncarney/overpunch"
+  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.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+end

data/spec/overpunch_spec.rb

@@ -0,0 +1,102 @@
+require "overpunch"
+
+RSpec::Matchers.define :be_zero_padded do |expected_zeroes|
+  def pluralize_zero(number)
+    if number == 1
+      "#{number} zero"
+    else
+      "#{number} zeroes"
+    end
+  end
+
+  match do |actual|
+    actual.match(/\A0{#{expected_zeroes}}[^0]/)
+  end
+
+  description do
+    "be padded with #{pluralize_zero(expected_zeroes)}"
+  end
+
+  failure_message do |actual|
+    "expected \"#{actual}\" to be padded with exactly #{pluralize_zero(expected_zeroes)}"
+  end
+
+  failure_message_when_negated do |actual|
+    "did not expect \"#{actual}\" to be padded with #{pluralize_zero(expected_zeroes)}"
+  end
+end
+
+
+describe Overpunch do
+  describe ".parse" do
+    subject(:parse) { Overpunch.parse(value) }
+
+    context "given a positive overpunch string" do
+      let(:expected_value)  { rand 0..1000 }
+      let(:value)           { "%d%s" % [ expected_value / 10, "{ABCDEFGHI"[expected_value % 10] ] }
+
+      it { is_expected.to eq expected_value }
+    end
+
+    context "given a negative overpunch string" do
+      let(:expected_value)  { -rand(0..1000) }
+      let(:value)           { "%d%s" % [ expected_value.abs / 10, "}JKLMNOPQR"[expected_value.abs % 10] ] }
+
+      it { is_expected.to eq expected_value }
+    end
+
+    context "given leading zeroes" do
+      let(:expected_value)  { rand 0..1000 }
+      let(:value)           { "%s%d%s" % [ "0" * rand(1..2), expected_value / 10, "{ABCDEFGHI"[expected_value % 10] ] }
+
+      it { is_expected.to eq expected_value }
+    end
+
+    context "given an invalid overpunch string" do
+      let(:value) { "123X" }
+
+      example { expect { parse }.to raise_error ArgumentError, "Invalid overpunch string: \"#{value}\"" }
+    end
+  end
+
+  describe '.format' do
+    let(:width) { nil }
+
+    subject { Overpunch.format(value, width: width) }
+
+    {
+         0 =>   "{",
+         5 =>   "E",
+        10 =>  "1{",
+       321 => "32A",
+       219 => "21I",
+        -2 =>   "K",
+       -10 =>  "1}",
+      -431 => "43J",
+      -729 => "72R"
+    }.each do |integer_value, expected_overpunch|
+      context "given #{integer_value}" do
+        let(:value) { integer_value }
+
+        it { is_expected.to eq expected_overpunch }
+      end
+    end
+
+    describe "zero-padding" do
+      let(:width) { 4 }
+
+      {  1000 => 0,
+        -1000 => 0,
+            1 => 3,
+          -10 => 2,
+          123 => 1
+      }.each do |integer_value, expected_zeroes|
+        context "given #{integer_value}" do
+          let(:value) { integer_value }
+
+          it { is_expected.to be_zero_padded(expected_zeroes) }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,76 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  require "rspec/its"
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  # config.filter_run :focus
+  # config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: overpunch
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Carney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: Simple module for parsing and formatting numbers in signed overpunch
+  format.
+email:
+- john@carney.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/overpunch.rb
+- lib/overpunch/version.rb
+- overpunch.gemspec
+- spec/overpunch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/johncarney/overpunch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: Parses and formats numbers in signed overpunch format.
+test_files:
+- spec/overpunch_spec.rb
+- spec/spec_helper.rb