dumb_delimited 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4522a4b2571eae677938c2c9ff3a20ed7d0a2b22
+  data.tar.gz: 7d832b4eaf31490dd95f6e547ddf9e74e677f712
+SHA512:
+  metadata.gz: 3cd992cc109129c7342815b227c6ebe4ac167c0635917d894774b5509fc92e7f5f119fe5bb9fc8aeeedd2f3d9937bc031ea71059172fb44d5f1d8fc942492cad
+  data.tar.gz: eef544b4373011f28996a3a902d25a354baf961aa4655f3819889132660adad59031811b776afe52bbba22fc36440e5731f270b10779323f805c27f4472f81c0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dumb_delimited.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonathan Hefner
+
+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,111 @@
+# dumb_delimited
+
+A library for unsophisticated delimited flat file IO.  *dumb_delimited*
+mixes models and persistence in that "probably wrong but feels so right"
+kind of way.
+
+
+## Usage Example
+
+Let's say we have a products file "products.csv", and a customers
+file "customers.psv".
+
+"products.csv" is a comma-delimited flat file and has four columns: SKU,
+Product Name, Base Price, and Sale Price.  An example row from
+"products.csv" might be:
+
+```
+AB81H0F,Widget Alpha,899.99,499.99
+```
+
+"customers.psv" is a pipe-delimited flat file and has three columns:
+Customer Name, Email, and Address.  An example row from "customers.psv"
+might be:
+
+```
+Bob Bobbington|best_bob@bobbers.bob|808 Bounce Lane, Austin, TX 78703
+```
+
+To interact with these files, we create model classes via the
+`DumbDelimited#[]` method.  Note that a created class can either be used
+as a superclass or simply assigned to a constant.
+
+```ruby
+class Product < DumbDelimited[:sku, :name, :base_price, :sale_price]
+  def on_sale?
+    sale_price < base_price
+  end
+end
+
+Customer = DumbDelimited[:name, :email, :address]
+Customer.delimiter = "|"
+```
+
+Because "customers.psv" is pipe-delimited, we also set the delimiter
+for the Customer class.  By default, model classes use comma (`","`) as
+the delimiter.  Whenever a delimiter is set, it applies to all future
+IO operations for that model class.
+
+Now we can read each flat file, and recieve an array of model objects.
+
+```ruby
+products = Product.parse_file("products.csv")
+customers = Customer.parse_file("customers.psv")
+```
+
+This, however, will load the entire contents of each file into memory.
+Let's say our customers file is very large, and we would prefer to
+iterate over it rather than load it all into memory at once.  To do so,
+we can use the `each_in_file` method that the model class provides.
+Below is a complete example in which we load our product data, create a
+listing of products on sale, and iterate over our customers, notifying
+each customer of the sale products:
+
+```ruby
+products = Product.parse_file("products.csv")
+
+listing = products.select(&:on_sale?).map do |product|
+  "* #{product.name} (#{product.sale_price})"
+end.join("\n")
+
+Customer.each_in_file("customers.psv") do |customer|
+  message =
+    "Hi #{customer.name}!\n\n" \
+    "The following products are on sale:\n\n#{listing}"
+
+  notify(customer.email, message)
+end
+```
+
+Let's say the sale is now over, and we want to change our sale prices
+back to our base prices.  *dumb_delimited* includes the
+[*pleasant_path*](https://github.com/jonathanhefner/pleasant_path) gem,
+which offers a fluent API for writing files.  To finish our task, we use
+the `Array#write_to_file` method provided by *pleasant_path*, which in
+turn invokes `Product#to_s` (provided by *dumb_delimited*) on each model
+object.
+
+```ruby
+Product.parse_file("products.csv").each do |product|
+  product.sale_price = product.base_price
+end.write_to_file("products.csv")
+```
+
+For a more detailed explanation of the *dumb_delimited* API, browse the
+[full documentation](http://www.rubydoc.info/gems/dumb_delimited/).
+
+
+## Installation
+
+    $ gem install dumb_delimited
+
+
+## Development
+
+Run `rake test` to run the tests.  You can also run `rake irb` for an
+interactive prompt that pre-loads the project code.
+
+
+## License
+
+[MIT License](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+end
+
+desc "Launch IRB with this gem pre-loaded"
+task :irb do
+  require "dumb_delimited"
+  require "irb"
+  ARGV.clear
+  IRB.start
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/dumb_delimited.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dumb_delimited/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dumb_delimited"
+  spec.version       = DumbDelimited::VERSION
+  spec.authors       = ["Jonathan Hefner"]
+  spec.email         = ["jonathan.hefner@gmail.com"]
+
+  spec.summary       = %q{Library for unsophisticated delimited flat file IO}
+  spec.homepage      = "https://github.com/jonathanhefner/dumb_delimited"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "pleasant_path", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

data/lib/dumb_delimited.rb

@@ -0,0 +1,158 @@
+require "CSV"
+require "pleasant_path"
+require "dumb_delimited/version"
+
+
+module DumbDelimited
+
+  # Returns a model class for delimited data consisting of the specified
+  # columns.  The returned class inherits from Ruby's
+  # {https://ruby-doc.org/core/Struct.html +Struct+}, allowing data
+  # manipulation via accessor methods, via indexing by column name, and
+  # via indexing by column number.  See {ClassMethods} and
+  # {InstanceMethods} for the IO methods the returned class provides.
+  #
+  # @example
+  #   class Product < DumbDelimited[:sku, :name, :base_price, :sale_price]
+  #     def on_sale?
+  #       sale_price < base_price
+  #     end
+  #   end
+  #
+  #   Customer = DumbDelimited[:name, :email, :address]
+  #
+  # @param columns [*Symbol]
+  # @return [Class]
+  def self.[](*columns)
+    Struct.new(*columns) do
+      extend DumbDelimited::ClassMethods
+      include DumbDelimited::InstanceMethods
+    end
+  end
+
+end
+
+
+module DumbDelimited::ClassMethods
+
+  # Returns the advanced options Hash.  The Hash is not +dup+ed and can
+  # be modified directly.  Any modifications will be applied to all
+  # future IO operations for the model class.  For detailed information
+  # about available options, see Ruby's
+  # {http://ruby-doc.org/stdlib/libdoc/csv/rdoc/CSV.html#method-c-new
+  # CSV module}.
+  #
+  # @return [Hash]
+  def options
+    @options ||= {
+      col_sep: ',',
+      skip_blanks: true,
+      converters: :numeric,
+    }
+  end
+
+  # Sets the advanced options Hash.  The entire Hash is replaced, and
+  # the new value will be applied to all future IO operations for the
+  # model class.  To set options individually, see {options}.  For
+  # detailed information about available options, see Ruby's
+  # {http://ruby-doc.org/stdlib/libdoc/csv/rdoc/CSV.html#method-c-new
+  # CSV module}.
+  #
+  # @param o [Hash]
+  def options=(o)
+    @options = o
+  end
+
+  # Returns the column delimiter used in IO operations.  Defaults to a
+  # comma (<code>","</code>).
+  #
+  # @return [String]
+  def delimiter
+    self.options[:col_sep]
+  end
+
+  # Sets the column delimiter used in IO operations.  The new value will
+  # be used in all future IO operations for the model class.  Any
+  # delimiter can be safely chosen, and all IO operations will quote
+  # field values as necessary.
+  #
+  # @example
+  #   Point = DumbDelimited[:x, :y, :z]
+  #   p = Point.new(1, 2, 3)
+  #   p.to_s  # == "1,2,3"
+  #   Point.delimiter = "|"
+  #   p.to_s  # == "1|2|3"
+  #
+  # @param d [String]
+  def delimiter=(d)
+    self.options[:col_sep] = d
+  end
+
+  # Parses a single delimited line into a model object.
+  #
+  # @example
+  #   Point = DumbDelimited[:x, :y, :z]
+  #   p = Point.parse_line("1,2,3")
+  #   p.is_a?(Point)  # == true
+  #   p.to_a          # == [1, 2, 3]
+  #
+  # @param line [String]
+  # @return [self]
+  def parse_line(line)
+    self.new(*CSV.parse_line(line, self.options))
+  end
+
+  # Parses an entire delimited file into an array of model objects.
+  # This will load the entire contents of the file into memory, and may
+  # not be suitable for large files.  To iterate over file contents
+  # without loading it all into memory at once, use {each_in_file}.
+  #
+  # @example
+  #   # CONTENTS OF FILE "points.csv":
+  #   # 1,2,3
+  #   # 4,5,6
+  #   # 7,8,9
+  #
+  #   Point = DumbDelimited[:x, :y, :z]
+  #   points = Point.parse_file("points.csv")
+  #   points.map(&:x)  # == [1, 4, 7]
+  #
+  # @param path [String, Pathname]
+  # @return [Array<self>]
+  def parse_file(path)
+    each_in_file(path).to_a
+  end
+
+  # Iterates over a delimited file, parsing one row at a time into model
+  # objects.  This avoids loading the entire contents of the file into
+  # memory at once.  If a block is given, it will be passed a model
+  # object for each row in the file.  Otherwise, if a block is not
+  # given, an Enumerator will be returned.  Note that some Enumerator
+  # methods, such as +Enumerator#to_a+, will cause the entire contents
+  # of the file to be loaded into memory regardless.
+  #
+  # @param path [String, Pathname]
+  # @yieldparam [self] current model object
+  # @return [Enumerator<self>, nil]
+  def each_in_file(path)
+    return to_enum(__method__, path) unless block_given?
+
+    CSV.foreach(path, self.options) do |row|
+      yield self.new(*row)
+    end
+  end
+
+end
+
+
+module DumbDelimited::InstanceMethods
+
+  # Serializes a model object to a delimited string, using the delimiter
+  # specified by {ClassMethods.delimiter}.
+  #
+  # @return [String]
+  def to_s
+    CSV.generate_line(self, self.class.options).chomp!
+  end
+
+end

data/lib/dumb_delimited/version.rb

@@ -0,0 +1,3 @@
+module DumbDelimited
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: dumb_delimited
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Hefner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pleasant_path
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- jonathan.hefner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dumb_delimited.gemspec
+- lib/dumb_delimited.rb
+- lib/dumb_delimited/version.rb
+homepage: https://github.com/jonathanhefner/dumb_delimited
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Library for unsophisticated delimited flat file IO
+test_files: []