fat_table 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4c545f67e0496d870adfa57ec7bdbe6b8b0b5af8
-  data.tar.gz: 59a03a6b61876344facf14a5ec6a65bf47300b33
+SHA256:
+  metadata.gz: 558944c93313d81954da19744fec105b8562a4634781f77accd0fd7677dce76b
+  data.tar.gz: e301c37c690d01a77a24679e676c35cefd0f68b01d72b4e16835e54e44223790
 SHA512:
-  metadata.gz: ec213d073ddad80a8167b05e3a0fad399886c605a41160c41c428e2664f030f862c159bb077558521ce1bb32fd004527ec540fb8e3e51906d993712b9be0abeb
-  data.tar.gz: e160d5bacf83be72296029835f22412565e27649c097869f2653b86b8b23a65d0d541593349221fde1c5b6dc381785b0d192f3cd434269c6a2647362f433cfdc
+  metadata.gz: 6430e39eb4261ab51eb855a0e3119e7bfae2e0f104215e637d8091d8d2ba4847f8b2e91ee1b1be08531bc69a72dc4a4b6233fbbc2d0f8fa7b43c11c73ac8c305
+  data.tar.gz: 1eec9ab1576cdda1ebdcd0833601573f343ecab9cd16244c6fd4038b6a3dc86ba7303b693e7c7d852ef1443e9b2b3d20b9ff32ccb652fcb73a92e7337d3511c7

data/.travis.yml

@@ -16,4 +16,5 @@ rvm:
   - 2.2.2
   - 2.3
   - 2.4
+  - 2.5
   - ruby-head

data/.yardopts

@@ -1 +1,5 @@
---no-private lib/**/*.rb --markup=markdown --main=README.rdoc - README.rdoc
+--no-private lib/**/*.rb
+--markup=markdown
+--main=md/README.md
+-
+md/README.md

data/README.org

@@ -2,7 +2,11 @@
 #+LATEX_HEADER: \usepackage[margin=0.75in]{geometry}
 
 #+BEGIN_COMMENT
+This is for markdown output:
+
 [![Build Status](https://travis-ci.org/ddoherty03/fat_table.svg?branch=master)](https://travis-ci.org/ddoherty03/fat_table)
+
+The following is for org.
 #+END_COMMENT
 
 [[https://travis-ci.org/ddoherty03/fat_table.svg?branch=master]]
@@ -12,7 +16,7 @@
 ~FatTable~ is a gem that treats tables as a data type. It provides methods for
 constructing tables from a variety of sources, building them row-by-row,
 extracting rows, columns, and cells, and performing aggregate operations on
-columns. It also provides as set of SQL-esque methods for manipulating table
+columns. It also provides a set of SQL-esque methods for manipulating table
 objects: ~select~ for filtering by columns or for creating new columns, ~where~
 for filtering by rows, ~order_by~ for sorting rows, ~distinct~ for eliminating
 duplicate rows, ~group_by~ for aggregating multiple rows into single rows and
@@ -31,7 +35,7 @@ no-ops.
 ~FatTable~ can be used to perform operations on data that are naturally best
 conceived of as tables, which in my experience is quite often. It can also serve
 as a foundation for providing reporting functions where flexibility about the
-output medium can be quite useful. Finally ~FatTable~ can be used within Emacs
+output medium can be useful. Finally ~FatTable~ can be used within Emacs
 ~org-mode~ files in code blocks targeting the Ruby language. Org mode tables are
 presented to a ruby code block as an array of arrays, so ~FatTable~ can read
 them in with its ~.from_aoa~ constructor. A ~FatTable~ table output as an array
@@ -76,7 +80,7 @@ Or install it yourself as:
 
 ~FatTable~ provides table objects as a data type that can be constructed and
 operated on in a number of ways. Here's a quick example to illustrate the use of
-the main features of ~FatTable~. See the detailed explanations further on down.
+~FatTable~. See the detailed explanations further on down.
 
 #+HEADER: :colnames no :session readme :hlines yes :wrap EXAMPLE :exports both
 #+BEGIN_SRC ruby
@@ -165,11 +169,12 @@ the main features of ~FatTable~. See the detailed explanations further on down.
 
 ** A Word About the Examples
 
-When you install the ~fat_table~ gem, you have access to a program ~ft_console~
+When you install the ~fat_table~ gem, you have access to a program ~ft_console~,
 which opens a ~pry~ session with ~fat_table~ loaded and the tables used in the
 examples in this ~README~ defined as instance variables so you can experiment
 with them. Because they are defined as instance variables, you have to write
-~tab1~ as ~@tab1~ in ~ft_console~, but otherwise the examples should work.
+~tab1~ as ~@tab1~ in ~ft_console~, but otherwise the examples should work as
+shown in this ~README~.
 
 The examples in this ~README~ file are executed as code blocks within the
 ~README.org~ file, so they typically end with a call to ~.to_aoa~. That causes
@@ -231,7 +236,7 @@ locals: _  __  _dir_  _ex_  _file_  _in_  _out_  _pry_  lib  str  version
 [4] pry(main)>
 #+END_EXAMPLE
 
-And if you use ~.to_term~, you can see the effect of the color formatting
+If you use ~puts table.to_term~, you can see the effect of the color formatting
 directives.
 
 ** Anatomy of a Table
@@ -478,15 +483,15 @@ This example illustrates several things:
    where the number of shares is greater than 500.  More on that later.
 4. ~FatTable~ passes back to org-mode an array of arrays using the ~.to_aoa~
    method. In an ~org-mode~ buffer, these are rendered as tables. We'll often
-   apply ~.to_aoa~ at the end of example blocks to render the results inside
-   this ~README.org~ file. As we'll see below, this method can also take a block
-   to which formatting directives and footers can be attached.
+   apply ~.to_aoa~ at the end of example blocks in this ~README~ to render the
+   results as a table inside this file. As we'll see below, ~.to_aoa~ can also
+   take a block to which formatting and footer directives can be attached.
 
 *** From Arrays of Hashes
 
 A second ruby data structure that can be used to initialize a ~FatTable~ table
 is an array of ruby Hashes. Each hash represents a row of the table, and the
-headers of the table are take from the keys of the hashes. Accordingly, all the
+headers of the table are taken from the keys of the hashes. Accordingly, all the
 hashes should have the same keys.
 
 This same method can in fact take an array of any objects that can be converted
@@ -517,7 +522,7 @@ tab = FatTable.from_aoh(aoh)
 #+END_SRC
 
 Notice, again, that the values can either be ruby objects, such as ~Date.today~,
-or strings that can parsed into one of the permissible column types.
+or strings that can be parsed into one of the permissible column types.
 
 *** From SQL queries
 
@@ -528,29 +533,19 @@ database parameters to be used for the queries.
 #+BEGIN_SRC ruby
   # This automatically requires sequel.
   require 'fat_table'
-  FatTable.set_db(driver: 'Pg',
+  FatTable.set_db(adapter: 'postgres',
                   database: 'XXX_development',
-                  user: 'dtd',
-                  password: 'slflpowert',
-                  host: 'localhost',
-                  socket: '/tmp/.s.PGSQL.5432')
+                  user: 'ken',
+                  password: 'imsecret',
+                  host: 'db.lan')
   tab = FatTable.from_sql('select * from trades;')
 #+END_SRC
 
-Some of the parameters to the ~.set_db~ function have defaults. The driver
-defaults to ~'Pg'~ for postgresql and the socket defaults to
-~/tmp/.s.PGSQL.5432~ if the host is 'localhost', which it is by default. If the
-host is not ~'localhost'~, the dsn uses a port rather than a socket and defaults
-to port ~'5432'~. While user and password default to nil, the database parameter
-is required.
-
-The ~.set_db~ function need only be called once, and the database handle it
-creates will be used for all subsequent ~.from_sql~ calls until ~.set_db~ is
-called again.
-
-Alternatively, you can build the ~Sequel~ connection with ~Sequel.connect~ or
-with adapter-specific ~Sequel~ connection methods and let ~FatTable~ know to use
-that connection:
+The arguments to ~set_db~ are simply passed on to ~sequel~'s connect method, so
+any set of arguments that work for it should work for ~set_db~. Alternatively,
+you can build the ~Sequel~ connection directly with ~Sequel.connect~ or with
+adapter-specific ~Sequel~ connection methods and let ~FatTable~ know to use that
+connection:
 
 #+BEGIN_SRC ruby
   require 'fat_table'
@@ -561,8 +556,15 @@ that connection:
 Consult ~Sequel's~ documentation for details on its connection methods.
 [[http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html]]
 
+The ~.set_db~ function need only be called once, and the database handle it
+creates will be used for all subsequent ~.from_sql~ calls until ~.set_db~ is
+called again.
+
 *** Marking Groups in Input
 
+~FatTable~ tables has a concept of "groups" of rows that play a role in many of
+the methods for operating on them as explained [[Groups][below]].
+
 The ~.from_aoa~ and ~.from_aoh~ functions take an optional keyword parameter
 ~hlines:~ that, if set to ~true~, causes them to mark group boundaries in the
 table wherever a row Array (for ~.from_aoa~) or Hash (for ~.from_aoh~) is
@@ -582,6 +584,7 @@ beginning with something like '~|---~'. The ~.from_org_...~ functions always
 recognizes hlines in the input, so it takes no ~hlines:~ keyword parameter.
 
 ** Accessing Parts of Tables
+
 *** Rows
 
 A ~FatTable~ table is an Enumerable, yielding each row of the table as a Hash
@@ -637,6 +640,7 @@ operation, which mutates the receiver table by removing its group boundaries.
 Second, because each operation returns a ~FatTable::Table~ object, the
 operations are chainable.
 
+<<Groups>>
 Third, ~FatTable::Table~ objects can have "groups" of rows within the table.
 These can be decorated with hlines and group footers on output. Some of these
 operations result in marking group boundaries in the result table, others remove

data/fat_table.gemspec

@@ -72,6 +72,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'redcarpet'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
 
   spec.add_runtime_dependency 'activesupport', '>3.0'

data/lib/fat_table/db_handle.rb

@@ -18,7 +18,7 @@ module FatTable
   #    Sequel's adapter-specific connection methods.
   #    http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html
   #
-  # +driver+::
+  # +adapter+::
   #    One of 'pg' (for Postgresql), 'mysql' or 'mysql2' (for Mysql), or
   #    'sqlite' (for SQLite3) to specify the +Sequel+ driver to use. You may
   #    have to install the driver to make this work. By default use 'Pg'.
@@ -61,46 +61,6 @@ module FatTable
     handle
   end
 
-  # def self.set_db(adapter: 'postgres',
-  #                 database:,
-  #                 user: ENV['LOGNAME'],
-  #                 password: nil,
-  #                 host: 'localhost',
-  #                 port: nil,
-  #                 socket: '/tmp/.s.PGSQL.5432')
-  #   if db
-  #     self.handle = db
-  #   else
-  #     raise UserError, 'must supply database name to set_db' unless database
-
-  #     valid_drivers = %w[postgres mysql mysql2 sqlite]
-  #     unless valid_drivers.include?(driver)
-  #       msg = "'#{driver}' driver must be one of #{valid_drivers.join(' or ')}"
-  #       raise UserError, msg
-  #     end
-  #     if database.blank?
-  #       raise UserError, 'must supply database parameter to set_db'
-  #     end
-
-  #     if driver == 'sqlite'
-  #       dsn = "sqlite://#{database}"
-  #     else
-  #       pw_part = password ? ":#{password}" : ''
-  #       hst_part = host ? "@#{host}" : ''
-  #       prt_part = port ? ":#{port}" : ''
-  #       dsn = "#{driver}:://#{user}#{pw_part}#{hst_part}#{prt_part}/#{database}"
-  #     end
-
-  #     # Set the dsn for Sequel
-  #     begin
-  #       self.handle = Sequel.connect(dsn)
-  #     rescue Sequel::Error => ex
-  #       raise TransientError, "#{dsn}: #{ex}"
-  #     end
-  #   end
-  #   handle
-  # end
-
   # Return the +Sequel+ database handle.
   def self.db
     handle

data/lib/fat_table/table.rb

@@ -1270,7 +1270,7 @@ module FatTable
 
     # :category: Constructors
 
-    # Add a +row+ without marking it as a group boundary.
+    # Add a +row+ to this Table without marking it as a group boundary.
     def <<(row)
       add_row(row)
     end

data/lib/fat_table/version.rb

@@ -1,4 +1,4 @@
 module FatTable
   # The current version of FatTable
-  VERSION = '0.2.7'.freeze
+  VERSION = '0.2.8'.freeze
 end

data/{README.md → md/README.md}

@@ -44,8 +44,7 @@
 4.  [Development](#org62e325b)
 5.  [Contributing](#orgf51a2c9)
 
-<https://travis-ci.org/ddoherty03/fat_table.svg?branch=master>
-
+[![Build Status](https://travis-ci.org/ddoherty03/fat_table.svg?branch=v0.2.7)](https://travis-ci.org/ddoherty03/fat_table)
 
 <a id="org23d768e"></a>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fat_table
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Daniel E. Doherty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -280,7 +294,6 @@ files:
 - ".yardopts"
 - Gemfile
 - LICENSE.txt
-- README.md
 - README.org
 - README.rdoc
 - Rakefile
@@ -304,6 +317,7 @@ files:
 - lib/fat_table/patches.rb
 - lib/fat_table/table.rb
 - lib/fat_table/version.rb
+- md/README.md
 homepage: https://github.com/ddoherty03/fat_table
 licenses: []
 metadata:
@@ -325,7 +339,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Provides tools for working with tables as a data type.