pikelet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11dc1d24d271ec693d9f578c8372a33d05e688b1
+  data.tar.gz: e9ebc0ac3bdfd1e15a6f460df7f10ba8e5bd07f8
+SHA512:
+  metadata.gz: cb41dbb987f9860f67b69f5e11b4e52776282f9dac882d425c54a7dba218470875e7069cbf06223357766fd6e65e96c4894ad7085095790b56db2220b546cf77
+  data.tar.gz: a3e10c5f0e07aa8f935a784e3ea0cd95f8fec508f1ea5dc64db69fbdbb4d9791ab9e264420952d92a619a3986fa23f95467283f7d567fae1ab7bdb939bf25e95

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+pikelet

data/.ruby-version

@@ -0,0 +1 @@
+2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pikelet.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,164 @@
+# Pikelet
+
+A pikelet is a type of small pancake popular in Australia and New Zealand.
+Also, a simple flat-file database parser capable of dealing with
+files containing heterogeneous records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pikelet'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pikelet
+
+## Usage
+
+### Homogeneous records, fixed-width fields
+
+    require "pikelet"
+
+    data = <<-FLATFILE.gsub(/^\s*/, "")
+      Nicolaus  Copernicus
+      Tycho     Brahe
+    FLATFILE
+
+    definition = Pikelet.define do
+      first_name  0...10
+      last_name  10...20
+    end
+
+    definition.parse(data.split(/[\r\n]+/)).to_a
+
+    # => [#<struct first_name="Nicolaus", last_name="Copernicus">,
+    #  #<struct first_name="Tycho", last_name="Brahe">]
+
+### Heterogeneous records, fixed-width fields
+
+    require "pikelet"
+
+    data = <<-FLATFILE.gsub(/^\s*/, "")
+      NAMENicolaus  Copernicus
+      ADDR123 South Street    Nowhereville        45678Y    Someplace           Someland
+    FLATFILE
+
+    definition = Pikelet.define do
+      type_signature 0...4
+
+      record "NAME" do
+        first_name  4...14
+        last_name  14...24
+      end
+
+      record "ADDR" do
+        street_address  4...24
+        city           24...44
+        postal_code    44...54
+        state          54...74
+        country        74...94
+      end
+    end
+
+    definition.parse(data.split(/[\r\n]+/)).to_a
+
+    # => [#<struct
+    #   type_signature="NAME",
+    #   first_name="Nicolaus",
+    #   last_name="Copernicus">,
+    #  #<struct
+    #   type_signature="ADDR",
+    #   street_address="123 South Street",
+    #   city="Nowhereville",
+    #   postal_code="45678Y",
+    #   state="Someplace",
+    #   country="Someland">]
+
+### CSV files
+
+    require "pikelet"
+    require "csv"
+
+    data = <<-CSV.gsub(/^\s*/, "")
+      NAME,Nicolaus,Copernicus
+      ADDR,123 South Street,Nowhereville,45678Y,Someplace,Someland
+    CSV
+
+    definition = Pikelet.define do
+      type_signature 0
+
+      record "NAME" do
+        first_name 1
+        last_name  2
+      end
+
+      record "ADDR" do
+        street_address 1
+        city           2
+        postal_code    3
+        state          4
+        country        5
+      end
+    end
+
+    definition.parse(CSV.parse(data)).to_a
+
+    # => [#<struct
+    #   type_signature="NAME",
+    #   first_name="Nicolaus",
+    #   last_name="Copernicus">,
+    #  #<struct
+    #   type_signature="ADDR",
+    #   street_address="123 South Street",
+    #   city="Nowhereville",
+    #   postal_code="45678Y",
+    #   state="Someplace",
+    #   country="Someland">]
+
+### Inheritance
+
+    require "pikelet"
+
+    data = <<-FLATFILE.gsub(/^\s*/, "")
+      SIMPLENicolaus  Copernicus
+      FANCY Tycho     Brahe     Tykester
+    FLATFILE
+
+    definition = Pikelet.define do
+      type_signature 0...6
+
+      record "SIMPLE" do
+        first_name  6...16
+        last_name  16...26
+
+        record "FANCY" do
+          nickname 26...36
+        end
+      end
+    end
+
+    definition.parse(data.split(/[\r\n]+/)).to_a
+
+    # => [#<struct
+    #   type_signature="SIMPLE",
+    #   first_name="Nicolaus",
+    #   last_name="Copernicus">,
+    #  #<struct
+    #   type_signature="FANCY",
+    #   first_name="Tycho",
+    #   last_name="Brahe",
+    #   nickname="Tykester">]
+
+
+## Contributing
+
+1. Fork it ( http://github.com/johncarney/pikelet/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/pikelet/field_definition.rb

@@ -0,0 +1,22 @@
+module Pikelet
+  class FieldDefinition
+    attr_reader :indices, :type
+
+    def initialize(indices, type)
+      @indices = indices
+      @type = type
+    end
+
+    def parse(text)
+      value = indices.map { |index| text[index] }.join
+      case type
+      when :integer
+        value.to_i
+      when :overpunch
+        Overpunch.parse(value)
+      else
+        value.strip
+      end
+    end
+  end
+end

data/lib/pikelet/file_definition.rb

@@ -0,0 +1,37 @@
+module Pikelet
+  class FileDefinition
+    attr_reader :base_record_definition
+
+    def initialize(&block)
+      @base_record_definition = RecordDefinition.new(self, &block)
+    end
+
+    def record(type_signature, base_definition: nil, &block)
+      base_definition ||= base_record_definition
+      record_definitions[type_signature] = RecordDefinition.new(self, base_definition: base_definition, &block)
+    end
+
+    def record_definitions
+      @record_definitions ||= {}
+    end
+
+    def parse(data, &block)
+      records = Enumerator.new do |y|
+        data.each do |line|
+          record = base_record_definition.parse(line)
+          if record.respond_to?(:type_signature)
+            if definition = record_definitions[record.type_signature]
+              record = definition.parse(line)
+            end
+          end
+          y.yield(record)
+        end
+      end
+      if block_given?
+        records.each(&block)
+      else
+        records
+      end
+    end
+  end
+end

data/lib/pikelet/record_definition.rb

@@ -0,0 +1,34 @@
+module Pikelet
+  class RecordDefinition
+    attr_reader :file_definition, :field_definitions
+
+    def initialize(file_definition, base_definition: nil, &block)
+      @file_definition = file_definition
+      @field_definitions = base_definition && base_definition.field_definitions.dup || {}
+      if block_given?
+        instance_eval(&block)
+      end
+    end
+
+    def field(name, *indices, type: nil)
+      @record_class = nil
+      field_definitions[name] = Pikelet::FieldDefinition.new(indices, type: type)
+    end
+
+    def record(type_signature, &block)
+      file_definition.record(type_signature, base_definition: self, &block)
+    end
+
+    def parse(data)
+      record_class.new(*field_definitions.values.map { |field| field.parse(data) })
+    end
+
+    def method_missing(method, *args, **options)
+      field(method, *args, **options)
+    end
+
+    def record_class
+      @record_class ||= Struct.new(*field_definitions.keys.map(&:to_sym))
+    end
+  end
+end

data/lib/pikelet/version.rb

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

data/lib/pikelet.rb

@@ -0,0 +1,10 @@
+require "pikelet/version"
+require "pikelet/file_definition"
+require "pikelet/record_definition"
+require "pikelet/field_definition"
+
+module Pikelet
+  def self.define(&block)
+    Pikelet::FileDefinition.new(&block)
+  end
+end

data/pikelet.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pikelet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pikelet"
+  spec.version       = Pikelet::VERSION
+  spec.authors       = ["John Carney"]
+  spec.email         = ["john@carney.id.au"]
+  spec.summary       = %q{A simple flat-file database parser.}
+  spec.description   = %q{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.}
+  spec.homepage      = ""
+  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_runtime_dependency "overpunch"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: pikelet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Carney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: overpunch
+  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.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'
+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:
+- john@carney.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pikelet.rb
+- lib/pikelet/field_definition.rb
+- lib/pikelet/file_definition.rb
+- lib/pikelet/record_definition.rb
+- lib/pikelet/version.rb
+- pikelet.gemspec
+homepage: ''
+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: A simple flat-file database parser.
+test_files: []