conformist 0.0.3 → 0.1.0

metadata

@@ -1,120 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: conformist
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  version: 0.0.3
 platform: ruby
-authors: 
+authors:
 - Tate Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-07 00:00:00 +10:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70203800707960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.8.7
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70203800707960
+- !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70203800707420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.1.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: fastercsv
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.5.4
-  type: :runtime
-  prerelease: false
-  version_requirements: *id003
-description: Conformist lets you bend CSVs to your will. Let multiple, different input files conform to a single interface without rewriting your parser each time.
-email: 
+  version_requirements: *70203800707420
+description: Stop using array indexing and start using declarative schemas.
+email:
 - tate@tatey.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
-- CHANGELOG.markdown
+- CHANGELOG.md
 - Gemfile
 - LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - conformist.gemspec
 - lib/conformist.rb
 - lib/conformist/base.rb
+- lib/conformist/builder.rb
 - lib/conformist/column.rb
-- lib/conformist/row.rb
+- lib/conformist/hash_struct.rb
+- lib/conformist/schema.rb
 - lib/conformist/version.rb
-- test/conformist/base_test.rb
-- test/conformist/column_test.rb
-- test/conformist/conformist_test.rb
-- test/conformist/row_test.rb
-- test/definitions/acma.rb
-- test/definitions/fcc.rb
 - test/fixtures/acma.csv
 - test/fixtures/fcc.txt
 - test/helper.rb
-has_rdoc: true
+- test/schemas/acma.rb
+- test/schemas/fcc.rb
+- test/unit/conformist/base_test.rb
+- test/unit/conformist/builder_test.rb
+- test/unit/conformist/column_test.rb
+- test/unit/conformist/hash_struct_test.rb
+- test/unit/conformist/schema_test.rb
+- test/unit/conformist_test.rb
+- test/unit/integration_test.rb
 homepage: https://github.com/tatey/conformist
 licenses: []
-
-post_install_message: 
+post_install_message: ! "********************************************************************************\n\n
+  \ Upgrading from <= 0.0.3? You should be aware of breaking changes. See\n  https://github.com/tatey/conformist
+  and skip to \"Upgrading from 0.0.3 to \n  0.1.0\" to learn more. Conformist will
+  raise helpful messages where necessary.\n\n********************************************************************************
+  \ \n"
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3830580058108286643
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -4117022895684605404
 requirements: []
-
 rubyforge_project: conformist
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Let multiple, different input files conform to a single interface.
-test_files: 
-- test/conformist/base_test.rb
-- test/conformist/column_test.rb
-- test/conformist/conformist_test.rb
-- test/conformist/row_test.rb
-- test/definitions/acma.rb
-- test/definitions/fcc.rb
+summary: Bend CSVs to your will.
+test_files:
 - test/fixtures/acma.csv
 - test/fixtures/fcc.txt
 - test/helper.rb
+- test/schemas/acma.rb
+- test/schemas/fcc.rb
+- test/unit/conformist/base_test.rb
+- test/unit/conformist/builder_test.rb
+- test/unit/conformist/column_test.rb
+- test/unit/conformist/hash_struct_test.rb
+- test/unit/conformist/schema_test.rb
+- test/unit/conformist_test.rb
+- test/unit/integration_test.rb

data/README.markdown

@@ -1,157 +0,0 @@
-# Conformist 
-
-Conformist lets you bend CSVs to your will. Let multiple, different input files conform to a single interface without rewriting your parser each time.
-
-Motivation for this project came from the desire to simplify importing data from various government organisations into [Antenna Mate](http://antennamate.com). The data from each government was similar, but had completely different formatting. Some pieces of data needed preprocessing while others simply needed to be concatenated together. I did not want to write a new parser for each new government organisation. Instead, I created Conformist.
-
-## Installation
-
-Conformist is available from rubygems.org.
-
-``` sh
-$ gem install conformist
-```
-
-## Usage
-
-You create a Ruby class, mix-in `Conformist::Base` and declare how an input file should map to a single interface.
-
-``` ruby
-require 'conformist'
-
-class Citizen1
-  include Conformist::Base
-    
-  column :name, 0, 1
-  column :city, 2 do |value|
-    value.upcase
-  end
-end
-
-class Citizen2
-  include Conformist::Base
-  
-  column :name, 0
-  column :city, 1
-end
-```
-
-Load up your definitions and enumerate over each row in the input file.
-
-``` ruby
-Conformist.foreach Citizen1.load('citizens1.csv'), Citizen2.load('citizens2.csv') do |row|
-  Citizen.create! row
-end
-```
-
-Each object passed into the block will be a hash. Perfect for passing to a model to save into a datastore (Or whatever tickles your fancy).
-
-### Option
-
-Conformist uses CSV (Formally FasterCSV) to perform the heavy lifting. You can declare options that should be passed to CSV at runtime. It is safe to call `option` multiple times.
-
-``` ruby
-option :col_sep => ','
-option :quote_char => '"'
-```
-
-### One Column
-
-Maps the first column in the input file to the `:first_name` key-value pair. Indexing starts at zero.
-
-``` ruby
-column :first_name, 0
-```
-
-### Many Columns
-
-Maps the first and second columns in the input file to the `:name` key-value pair and implicitly concatenates the values.
-
-``` ruby
-column :name, 0, 1
-```
-
-Indexing is completely arbitrary and you can map any combination.
-
-``` ruby
-column :name_and_city 0, 2
-```
-
-### Preprocessing
-
-Sometimes you will want to manipulate values before they're conformed. You can pass a block and get access to the values. The return value of the expression becomes the conformed output.
-
-``` ruby
-column :name, 0, 1 do |values|
-  values.map { |v| v.upcase } * ' '
-end
-```
-
-Works with one column too. Instead of getting an array of strings, you get one string.
-
-``` ruby
-column :first_name, 0 do |value|
-  value.upcase
-end
-```
-
-### Virtual Columns
-
-Declare a column you want included in the conformed output that is not based on the input file. This is useful when you need to set values based on the conformist definition. 
-
-``` ruby
-column :day do 
-  1
-end
-```
-
-### Inheritance
-
-Inheriting from a class which mixes in Conformist::Base gives you access to all of the superclasses' columns.
-
-``` ruby
-class Citizen
-  include Conformist::Base
-
-  column :name, 0, 1
-end
-
-class Adult < Citizen
-  column :category do
-    'Adult'
-  end
-end
-
-class Child < Citizen
-  column :category do
-    'Child'
-  end
-end
-
-Adult.load('adults.csv').foreach do |row|
-  row # => {:name => 'Tate Johnson', :category => 'Adult}
-end
-```
-## Example
-
-* https://gist.github.com/949576
-
-## Compatibility
-
-* 1.9.2-p180
-* 1.8.7-p334
-* jruby-1.6.1
-
-## Contributing
-
-Patches welcome! 
-
-1. Fork the repository
-2. Create a topic branch
-3. Write tests and make changes
-4. Make sure the tests pass by running `rake`
-5. Push and send a pull request on GitHub
-
-## Copyright
-
-Copyright © 2011 Tate Johnson. Conformist is released under the MIT license. See LICENSE for details.

data/lib/conformist/row.rb

@@ -1,26 +0,0 @@
-module Conformist
-  class Row
-    attr_reader :columns, :row
-    
-    def initialize columns, row
-      @columns, @row = columns, row
-    end
-    
-    # Extracts key-value pairs for each column in the row. Will implicitly
-    # join an array into a string.
-    #
-    # Example:
-    #
-    #   row = Row.new columns, csv_row
-    #   row.to_hash # => {:first => 'Hello', :second => 'World'}
-    #
-    # Returns conformed hash.
-    def to_hash
-      columns.inject({}) do |attributes, column|
-        values = column.values_in row
-        values = values.join if values.respond_to? :join
-        attributes.merge column.name => values
-      end
-    end
-  end
-end

data/test/conformist/base_test.rb

@@ -1,49 +0,0 @@
-require 'helper'
-
-class BaseTest < MiniTest::Unit::TestCase
-  def setup
-    @class = Class.new.tap { |klass| klass.send :include, Conformist::Base }
-  end
-  
-  def test_option
-    @class.option :a => 1
-    @class.option :b => 2
-    assert_equal({:a => 1, :b => 2}, @class.options)
-  end
-  
-  def test_column
-    @class.column :a, 0
-    @class.column :b, 1
-    assert_equal 2, @class.columns.size
-    assert_instance_of Conformist::Column, @class.columns[rand(2)]
-  end
-  
-  def test_columns_inherit_from_superclass
-    subclass = Class.new @class
-    @class.column :a, 0
-    @class.column :b, 1
-    assert_equal @class.columns, subclass.columns
-    subclass.column :c, 2
-    subclass.column :d, 3
-    refute_equal @class.columns, subclass.columns
-  end
-  
-  def test_load
-    instance = @class.load 'file'
-    assert_equal 'file', instance.path
-    assert_instance_of @class, instance
-  end
-  
-  def test_foreach
-    rows = [
-      {:name => "CRAFERS", :callsign => "ABS2",  :latitude => "34 58 49S"},
-      {:name => "CRAFERS", :callsign => "SAS7",  :latitude => "34 58 57S"},
-      {:name => "CRAFERS", :callsign => "NWS9",  :latitude => "34 59 02S"},
-      {:name => "CRAFERS", :callsign => "ADS10", :latitude => "34 59 02S"},
-      {:name => "CRAFERS", :callsign => "ADS10", :latitude => "34 58 57S"}
-    ]
-    ACMA.load(fixture('acma.csv')).foreach do |row|
-      assert_equal rows.shift, row
-    end
-  end
-end

data/test/conformist/conformist_test.rb

@@ -1,21 +0,0 @@
-require 'helper'
-
-class ConformistTest < MiniTest::Unit::TestCase
-  def test_foreach
-    rows = [
-      {:name => "CRAFERS",         :callsign => "ABS2",    :latitude => "34 58 49S",     :signtal_type => "digital"},
-      {:name => "CRAFERS",         :callsign => "SAS7",    :latitude => "34 58 57S",     :signtal_type => "digital"},
-      {:name => "CRAFERS",         :callsign => "NWS9",    :latitude => "34 59 02S",     :signtal_type => "digital"},
-      {:name => "CRAFERS",         :callsign => "ADS10",   :latitude => "34 59 02S",     :signtal_type => "digital"},
-      {:name => "CRAFERS",         :callsign => "ADS10",   :latitude => "34 58 57S",     :signtal_type => "digital"},
-      {:name => "LOS ANGELES, CA", :callsign => "KVTU-LP", :latitude => "34 11 13.90 N", :signtal_type => "digital"},
-      {:name => "BAKERSFIELD, CA", :callsign => "NEW",     :latitude => "35 12 6.00 N",  :signtal_type => "digital"},
-      {:name => "YUCA VALLEY, CA", :callsign => "NEW",     :latitude => "34 9 10.10 N",  :signtal_type => "digital"},
-      {:name => "SACRAMENTO, CA",  :callsign => "KCSO-LD", :latitude => "38 7 10.00 N",  :signtal_type => "digital"},
-      {:name => "LOS ANGELES, CA", :callsign => "KVTU-LP", :latitude => "34 13 38.00 N", :signtal_type => "digital"}
-    ]
-    Conformist.foreach ACMA::Digital.load(fixture('acma.csv')), FCC.load(fixture('fcc.txt')) do |row|
-      assert_equal rows.shift, row
-    end
-  end
-end

data/test/conformist/row_test.rb

@@ -1,21 +0,0 @@
-require 'helper'
-
-class RowTest < MiniTest::Unit::TestCase
-  def test_to_hash_should_join_array
-    column = Conformist::Column.new(:foo, 0, 1, 2)
-    row    = Conformist::Row.new [column], stub_row
-    assert_equal({:foo => 'abc'}, row.to_hash)
-  end
-  
-  def test_to_hash_should_not_join_string
-    column = Conformist::Column.new(:foo, 0, 1, 2) { |values| values.join('-').upcase }
-    row    = Conformist::Row.new [column], stub_row
-    assert_equal({:foo => 'A-B-C'}, row.to_hash)
-  end
-  
-  def test_to_hash_with_many_columns
-    columns = Conformist::Column.new(:foo, 0), Conformist::Column.new(:bar, 1, 2, 3)
-    row     = Conformist::Row.new columns, stub_row
-    assert_equal({:foo => 'a', :bar => 'bcd'}, row.to_hash)
-  end
-end