tblr 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16a4466ede557076281fb68ffad53f9c87150562
-  data.tar.gz: b44d1476cf6bb4426ce79e9c8cfae6ee79ed016f
+  metadata.gz: 2f60f49c7fa3131f9e0d18b76d5b35f599df0c4a
+  data.tar.gz: 3b3e869406b4196d4476cdbaca861ea78099edac
 SHA512:
-  metadata.gz: d1cfffeb154262f63c81ce6204a71830e29a3c994502f88082281640a6bb0e20bb745ce08da8080cfd9c00c27dc7f54a92f5eea8bec8db0ffc67d299f8725761
-  data.tar.gz: 940d80a8e671f64b483113db513d717c2ed0a260d8a42e8694244be8b869c1550f27c478268898e65a221a0860490ae23e864e87dec0a026211fdd8116438482
+  metadata.gz: 84f78e0953421b3c66b37cb64477fc24a45086e3d006c5768fe519001d8851bd4b3e1abd8704018124017f56ffa7b6a238bef161d2e048465be67a13420bab53
+  data.tar.gz: 91691e957e8b820bd38f62602b750efe92712d3e6ef9699c6962b2404fc4f1c23321b5849afa810dcefcfdb57b95912a0d848311334183f8ec64eded267fc91f

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -1,6 +1,6 @@
 # Tblr
 
-TODO: Write a gem description
+Table is a really little gem that gives you a table data type
 
 ## Installation
 
@@ -20,12 +20,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+create a table
 
-## Contributing
+```ruby
+headers = ['firstName', 'last_name']
+rows = [
+  %w(Barny Rubble),
+  %w(Fred Flinstone),
+  %w(Wilma Flinstone),
+]
+@table = Table.new(headers, rows)
+```
+
+Do things with your table
+
+```ruby
+@table.collect(&:firstName) #=> ['Rubble', 'Fred', 'Wilma']
+@table.size #=> 3
+@table[0] #=> #<Tblr::Row: @headers=["firstName", "last_name"], @row=["First", "Last"]>
+
+@table.group_by(&:last_name) #=>
+  # {
+  #   "Rubble" => #<Tblr::Table: @headers=["firstName", "last_name"],
+  #                @rows=[["Barny", "Rubble"]]>,
+  #   "Flinstone" => #<Tblr::Table: @headers=["firstName", "last_name"],
+  #                    @rows=[["Fred", "Flinstone"], ["Wilma", "Flinstone"]]>
+  # }
+```
+
+*Note*: Table includes Enumerable, so you can do all those things too.
+
+##Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/tblr/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Writes Specs, pull requrests will not be accepted without tests.
 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

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
 
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec
+

data/lib/tblr/row.rb

@@ -0,0 +1,54 @@
+module Tblr
+
+  module StringRefinements
+    refine String do
+      def camelize(first_letter = :upper)
+        result = self.split("_").map{|s| s.capitalize! }.join("")
+        case first_letter
+        when :upper; result
+        when :lower; result[0].downcase + result[1..-1]
+        end
+      end
+    end
+  end
+
+  class Row
+    using StringRefinements
+
+    def initialize(*args)
+      @headers = args[0]
+      @row = args[1]
+    end
+
+    def ==(another_row)
+      headers == another_row.headers &&
+        row == another_row.row
+    end
+
+    def to_a
+      row
+    end
+
+    def data_for_header(name)
+      idx = :nope
+      camel = name.camelize(:lower)
+      if headers.include?(name)
+        idx = headers.index(name)
+      elsif headers.include?(camel)
+        idx = headers.index(camel)
+      end
+
+      idx == :nope ? :nope : row[idx]
+    end
+
+    def method_missing(sym, *args, &block)
+      data = data_for_header(sym.to_s)
+      data == :nope ? super(sym, *args, &block) : data
+    end
+
+  protected
+
+    attr_accessor :headers, :row
+
+  end
+end

data/lib/tblr/table.rb

@@ -0,0 +1,41 @@
+module Tblr
+  class Table
+    include Enumerable
+
+    attr_reader :headers
+
+    def initialize(*args)
+      @headers = args[0]
+      @rows = args[1]
+    end
+
+    def ==(a_table)
+      headers == a_table.headers &&
+        rows == a_table.rows
+    end
+
+    def [](idx)
+      Tblr::Row.new(headers, rows[idx])
+    end
+
+    def each
+      @rows.each_with_index do |row, idx|
+        yield(Tblr::Row.new(headers, rows[idx]))
+      end
+    end
+
+    def group_by(*args, &block)
+      hash = self.map{|row| row}.group_by(*args, &block)
+      hash.each{|key, data| hash[key] = self.class.new(headers, data.map(&:to_a))}
+    end
+
+    def size
+      rows.size
+    end
+
+    protected
+
+    attr_reader :rows
+
+  end
+end

data/lib/tblr/version.rb

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

data/lib/tblr.rb

@@ -1,4 +1,6 @@
 require "tblr/version"
+require 'tblr/table'
+require 'tblr/row'
 
 module Tblr
   # Your code goes here...

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+# 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, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files 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
+
+require 'tblr'
+
+RSpec.configure do |config|
+  # 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|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  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|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # 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
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = 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
+=end
+end

data/spec/tblr/table_row_spec.rb

@@ -0,0 +1,45 @@
+include Tblr
+describe Tblr::Row do
+
+  before do
+    headers = ['firstName', 'last_name']
+    row = ['First', 'Last']
+    @row = Row.new(headers, row)
+  end
+
+  describe '#==' do
+    it 'should be equal to another' do
+      expect(@row).to eq Row.new(%w(firstName last_name), %w(First Last))
+    end
+  end
+
+  describe '#to_a' do
+    it 'should translate row to array' do
+      expect(@row.to_a).to eq %w(First Last)
+    end
+  end
+
+  describe '#missing_methods' do
+    it 'should be able to get row data by argument' do
+      expect(@row.first_name).to eq 'First'
+      expect(@row.last_name).to eq 'Last'
+    end
+
+    it 'should raise error if row doesnt contain the header' do
+      expect{@row.missing_name}.to raise_error NoMethodError
+    end
+
+    it 'should work if value is nil' do
+      row = Row.new(%w(firstName last_name), ['First', nil])
+      expect( row.last_name).to eq nil
+    end
+  end
+
+  describe '#data_for_header' do
+    it 'should return data from row for specific header' do
+      expect( @row.data_for_header('first_name')).to eq 'First'
+      expect( @row.data_for_header('last_name')).to eq 'Last'
+    end
+  end
+
+end

data/spec/tblr/table_spec.rb

@@ -0,0 +1,45 @@
+include Tblr
+describe Tblr::Table do
+
+  before do
+    headers = ['firstName', 'last_name']
+    rows = [
+      %w(First Last),
+      %w(Fred Flinstone),
+      %w(Wilma Flinstone),
+    ]
+    @table = Table.new(headers, rows)
+  end
+
+  describe '#each' do
+    it 'should support enumerable module' do
+      expect(@table.map(&:firstName)).to eq %w(First Fred Wilma)
+    end
+  end
+
+  describe '#size' do
+    it 'should return number of rows in table' do
+      expect(@table.size).to eq 3
+    end
+  end
+
+  describe '#[idx]' do
+    it 'should return idx row' do
+      expect(@table[0]).to eq Row.new(%w(firstName last_name), %w(First Last) )
+      expect(@table[1]).to eq Row.new(%w(firstName last_name), %w(Fred Flinstone) )
+    end
+  end
+
+  describe '#group_by' do
+    it 'should return an array of tables' do
+      expected = {
+        'Last' => Table.new(%w(firstName last_name), [%w(First Last)]),
+        'Flinstone' => Table.new(%w(firstName last_name), [
+          %w(Fred Flinstone), %w(Wilma Flinstone)
+        ])
+      }
+      expect(@table.group_by(&:last_name)).to eq expected
+    end
+  end
+
+end

data/tblr.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tblr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Benjamin Guest
@@ -14,30 +14,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: Initialize a Tblr::Table with headers and rows, do things with the table
 email:
 - benguest@gmail.com
@@ -45,13 +59,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/tblr.rb
+- lib/tblr/row.rb
+- lib/tblr/table.rb
 - lib/tblr/version.rb
+- spec/spec_helper.rb
+- spec/tblr/table_row_spec.rb
+- spec/tblr/table_spec.rb
 - tblr.gemspec
 homepage: ''
 licenses:
@@ -63,18 +83,21 @@ 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.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Little gem to support talbes
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/tblr/table_row_spec.rb
+- spec/tblr/table_spec.rb