dumb_delimited 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4522a4b2571eae677938c2c9ff3a20ed7d0a2b22
-  data.tar.gz: 7d832b4eaf31490dd95f6e547ddf9e74e677f712
+SHA256:
+  metadata.gz: 2a4d7deecbbed56e6940058fdc548436cbdb0f081b43164bc841017601c27726
+  data.tar.gz: b94ae4701ae2dec7cee54befe2e85c11ea20a9ae5906d0f7da6a8da1ef377eb6
 SHA512:
-  metadata.gz: 3cd992cc109129c7342815b227c6ebe4ac167c0635917d894774b5509fc92e7f5f119fe5bb9fc8aeeedd2f3d9937bc031ea71059172fb44d5f1d8fc942492cad
-  data.tar.gz: eef544b4373011f28996a3a902d25a354baf961aa4655f3819889132660adad59031811b776afe52bbba22fc36440e5731f270b10779323f805c27f4472f81c0
+  metadata.gz: 9f2994715b89523b10c4fb1375b2a073e306cedfae565f502241a4ad8f82876b1ec02d1b453641842ca331bba2812ea73783c70af7cc1431b0bbaeec83e0ce09
+  data.tar.gz: 36b9db417ddd340f695e1332ea005ad8ec03c3e8d31f5cc395b8479463497bee0e518e89f5916a90d0267ebfe9779abb21995d35e66f8da67b91f282e955b2b1

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 1.1.0
+
+* Fixed gem load on case-sensitive file systems.
+* Added `parse_text` class method.
+* Added `append_to_file` instance method.
+
+
+## 1.0.0
+
+* Initial release

data/README.md

@@ -27,8 +27,8 @@ 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.
+`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]
@@ -79,10 +79,10 @@ 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
+[*pleasant_path*](https://rubygems.org/gems/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
@@ -97,10 +97,20 @@ For a more detailed explanation of the *dumb_delimited* API, browse the
 
 ## Installation
 
-    $ gem install dumb_delimited
+Install from [Ruby Gems](https://rubygems.org/gems/dumb_delimited):
+
+```bash
+$ gem install dumb_delimited
+```
+
+Then require in your Ruby script:
+
+```ruby
+require "dumb_delimited"
+```
 
 
-## Development
+## Contributing
 
 Run `rake test` to run the tests.  You can also run `rake irb` for an
 interactive prompt that pre-loads the project code.
@@ -108,4 +118,4 @@ interactive prompt that pre-loads the project code.
 
 ## License
 
-[MIT License](http://opensource.org/licenses/MIT)
+[MIT License](https://opensource.org/licenses/MIT)

data/lib/dumb_delimited.rb

@@ -1,6 +1,6 @@
-require "CSV"
+require "csv"
 require "pleasant_path"
-require "dumb_delimited/version"
+require_relative "dumb_delimited/version"
 
 
 module DumbDelimited
@@ -45,7 +45,7 @@ module DumbDelimited::ClassMethods
   # @return [Hash]
   def options
     @options ||= {
-      col_sep: ',',
+      col_sep: ",",
       skip_blanks: true,
       converters: :numeric,
     }
@@ -92,9 +92,7 @@ module DumbDelimited::ClassMethods
   #
   # @example
   #   Point = DumbDelimited[:x, :y, :z]
-  #   p = Point.parse_line("1,2,3")
-  #   p.is_a?(Point)  # == true
-  #   p.to_a          # == [1, 2, 3]
+  #   Point.parse_line("1,2,3")  # == Point.new(1, 2, 3)
   #
   # @param line [String]
   # @return [self]
@@ -102,6 +100,25 @@ module DumbDelimited::ClassMethods
     self.new(*CSV.parse_line(line, self.options))
   end
 
+  # Parses a string into an array of model objects.
+  #
+  # @example
+  #   Point = DumbDelimited[:x, :y, :z]
+  #   Point.parse_text("1,2,3\n4,5,6\n7,8,9\n")
+  #     # == [
+  #     #      Point.new(1, 2, 3),
+  #     #      Point.new(4, 5, 6),
+  #     #      Point.new(7, 8, 9)
+  #     #    ]
+  #
+  # @param text [String]
+  # @return [Array<self>]
+  def parse_text(text)
+    # using CSV.new.each instead of CSV.parse to avoid unnecessary mass
+    # memory allocation and deallocation
+    CSV.new(text, self.options).each.map{|row| self.new(*row) }
+  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
@@ -114,8 +131,12 @@ module DumbDelimited::ClassMethods
   #   # 7,8,9
   #
   #   Point = DumbDelimited[:x, :y, :z]
-  #   points = Point.parse_file("points.csv")
-  #   points.map(&:x)  # == [1, 4, 7]
+  #   Point.parse_file("points.csv")
+  #     # == [
+  #     #      Point.new(1, 2, 3),
+  #     #      Point.new(4, 5, 6),
+  #     #      Point.new(7, 8, 9)
+  #     #    ]
   #
   # @param path [String, Pathname]
   # @return [Array<self>]
@@ -155,4 +176,26 @@ module DumbDelimited::InstanceMethods
     CSV.generate_line(self, self.class.options).chomp!
   end
 
+  # Serializes a model object to a delimited string, using the delimiter
+  # specified by {ClassMethods.delimiter}, and appends the string plus a
+  # row separator to the specified file.  Returns the model object.
+  # This method is convenient when working with single model objects,
+  # for example, appending a single entry to a log file.  However, it is
+  # not recommended for use with an array of model objects, due to the
+  # overhead of opening and closing the file for each append.
+  #
+  # @example
+  #   Point = DumbDelimited[:x, :y, :z]
+  #   Point.new(1, 2, 3).append_to_file("out.txt")  # == Point.new(1, 2, 3)
+  #   File.read("out.txt")                          # == "1,2,3\n"
+  #   Point.new(4, 5, 6).append_to_file("out.txt")  # == Point.new(4, 5, 6)
+  #   File.read("out.txt")                          # == "1,2,3\n4,5,6\n"
+  #
+  # @param file [String, Pathname]
+  # @return [self]
+  def append_to_file(file)
+    CSV.generate_line(self, self.class.options).append_to_file(file)
+    self
+  end
+
 end

data/lib/dumb_delimited/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dumb_delimited
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonathan Hefner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-02 00:00:00.000000000 Z
+date: 2018-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pleasant_path
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Library for unsophisticated delimited flat file IO