pikelet 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11dc1d24d271ec693d9f578c8372a33d05e688b1
-  data.tar.gz: e9ebc0ac3bdfd1e15a6f460df7f10ba8e5bd07f8
+  metadata.gz: ba77b8ff8d09025491cbe13b0cd6f18f735a3b84
+  data.tar.gz: 4949556c8adee37a5d0370d02a2bd1c1a3a1f544
 SHA512:
-  metadata.gz: cb41dbb987f9860f67b69f5e11b4e52776282f9dac882d425c54a7dba218470875e7069cbf06223357766fd6e65e96c4894ad7085095790b56db2220b546cf77
-  data.tar.gz: a3e10c5f0e07aa8f935a784e3ea0cd95f8fec508f1ea5dc64db69fbdbb4d9791ab9e264420952d92a619a3986fa23f95467283f7d567fae1ab7bdb939bf25e95
+  metadata.gz: 4c0afce709436d65d47d6234abbf8cc94dfbe61870a5c171bfa8b2314488cdfb3ce907a901767a3f3f95ad74cc8f251223c554eaa0a081aba663c7d2b8607c9e
+  data.tar.gz: 60432f02988c999c97d33c73418523997f58f2a0133707435a8fe61d749f5683a76d0c5dfb986fc446b0a76b39e2a130dc8536b10258272607edb567cba58580

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

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

data/lib/pikelet/field_definition.rb

@@ -1,8 +1,10 @@
+require "overpunch"
+
 module Pikelet
   class FieldDefinition
     attr_reader :indices, :type
 
-    def initialize(indices, type)
+    def initialize(indices, type: nil)
       @indices = indices
       @type = type
     end

data/lib/pikelet/version.rb

@@ -1,3 +1,3 @@
 module Pikelet
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/pikelet.gemspec

@@ -25,4 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec-collection_matchers"
+  spec.add_development_dependency "coveralls"
 end

data/spec/pikelet_spec.rb

@@ -0,0 +1,152 @@
+require "spec_helper"
+require "pikelet"
+require "csv"
+
+describe Pikelet do
+  RSpec::Matchers.define :match_hash do |expected|
+    match do |actual|
+      actual.to_h == expected
+    end
+  end
+
+  let(:records) { definition.parse(data).to_a }
+
+  subject { records }
+
+  describe "a simple flat file" do
+    let(:definition) do
+      Pikelet.define do
+        name   0... 4
+        number 4...13
+      end
+    end
+
+    let(:data) do
+      <<-FILE.gsub(/^\s*/, "").split(/[\r\n]+/)
+        John012345678
+        Sue 087654321
+      FILE
+    end
+
+    it { is_expected.to have(2).records }
+
+    its(:first) { is_expected.to match_hash(name: "John", number: "012345678") }
+    its(:last)  { is_expected.to match_hash(name: "Sue",  number: "087654321") }
+  end
+
+  describe "a file with heterogeneous records" do
+    let(:definition) do
+      Pikelet.define do
+        type_signature 0...1
+
+        record 'A' do
+          name   1... 5
+          number 5...14
+        end
+
+        record 'B' do
+          number  1...10
+          name   10...14
+        end
+      end
+    end
+
+    let(:data) do
+      <<-FILE.gsub(/^\s*/, "").split(/[\r\n]+/)
+        AJohn012345678
+        B087654321Sue
+      FILE
+    end
+
+
+    it { is_expected.to have(2).records }
+
+    its(:first) { is_expected.to match_hash(name: "John", number: "012345678", type_signature: "A") }
+    its(:last)  { is_expected.to match_hash(name: "Sue",  number: "087654321", type_signature: "B") }
+  end
+
+  describe "a CSV file" do
+    let(:definition) do
+      Pikelet.define do
+        name   0
+        number 1
+      end
+    end
+
+    let(:data) do
+      CSV.parse <<-FILE.gsub(/^\s*/, "")
+        John,012345678
+        Sue,087654321
+      FILE
+    end
+
+    it { is_expected.to have(2).records }
+
+    its(:first) { is_expected.to match_hash(name: "John", number: "012345678") }
+    its(:last)  { is_expected.to match_hash(name: "Sue",  number: "087654321") }
+  end
+
+  describe "inheritance" do
+    let(:definition) do
+      Pikelet.define do
+        type_signature 0...6
+
+        record 'SIMPLE' do
+          name 6...10
+
+          record 'FANCY' do
+            number 10...19
+          end
+        end
+      end
+    end
+
+    let(:data) do
+      <<-FILE.gsub(/^\s*/, "").split(/[\r\n]+/)
+        SIMPLEJohn012345678
+        FANCY Sue 087654321
+      FILE
+    end
+
+    it { is_expected.to have(2).records }
+
+    its(:first) { is_expected.to match_hash(name: "John", type_signature: "SIMPLE") }
+    its(:last)  { is_expected.to match_hash(name: "Sue",  number: "087654321", type_signature: "FANCY") }
+  end
+
+  describe "integer fields" do
+    let(:definition) do
+      Pikelet.define do
+        value 0...4, type: :integer
+      end
+    end
+
+    let(:data) do
+      <<-FILE.gsub(/^\s*/, "").split(/[\r\n]+/)
+        5637
+      FILE
+    end
+
+    subject { records.first }
+
+    its(:value) { is_expected.to eq 5637 }
+  end
+
+  describe "overpunch fields" do
+    let(:definition) do
+      Pikelet.define do
+        value 0...4, type: :overpunch
+      end
+    end
+
+    let(:data) do
+      <<-FILE.gsub(/^\s*/, "").split(/[\r\n]+/)
+        563J
+      FILE
+    end
+
+    subject { records.first }
+
+    its(:value) { is_expected.to eq -5631 }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+# 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"
+  require "rspec/collection_matchers"
+
+  # Coveralls
+  require "coveralls"
+
+  Coveralls.wear! do
+    add_filter 'spec'
+  end
+
+  # 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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pikelet
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Carney
@@ -66,6 +66,48 @@ dependencies:
     - - ">="
       - !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  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: coveralls
+  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: Pikelet is a type of small pancake popular in Australia and New Zealand.
   Also, a flat-file database parser capable of dealing with heterogeneous records.
 email:
@@ -74,9 +116,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,6 +131,8 @@ files:
 - lib/pikelet/record_definition.rb
 - lib/pikelet/version.rb
 - pikelet.gemspec
+- spec/pikelet_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -111,4 +157,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple flat-file database parser.
-test_files: []
+test_files:
+- spec/pikelet_spec.rb
+- spec/spec_helper.rb