eaternet 0.3.14 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 909fb5a4626a18c37b4d3694bd0fdf1a8f8b69a7
-  data.tar.gz: b6a05cf7dc6d76a5f10b4dc2e949c03d277da7da
+  metadata.gz: dd015ab0c5ca911589f85116ca59297a938ad9d8
+  data.tar.gz: 35bacfa01690959bc0f051b6208d6b460c9cba6d
 SHA512:
-  metadata.gz: e45b4ee75bf988fb28461b3cc19267ada7963e43967b80bb87537055b6f96a119829eafab6029bff68ede7830f433f129065a43a8a26827f51a09a4c9b81204c
-  data.tar.gz: 2cb9c2a9f6e221c52c8a8905e501aefd3b7f0a28cc4ff2e3d0a477726644eba9779c383aefefe94b988686265125b4ce70585b7f15136858835dbc9e397c4bec
+  metadata.gz: bdf91cc1304eb2c2ab998c06fb57c22e73bb0cf1e766c1abb5e148c43976db802d5da7981ad0843bfc456c6bd74969df60f5e7274012169d1c06fc7f940a0326
+  data.tar.gz: cdceb406ed81a5eabb6d5cf9c78be604392f8022cf9c786fae625f726c24ccee572ed947935b192ce5f4e3c84d898e3f86b3be1ec2edea9984f55e44cc309fed

data/lib/eaternet/agencies/nyc.rb

@@ -4,7 +4,7 @@ require 'logger'
 require 'set'
 require 'tempfile'
 
-require 'ext/lazy'
+require 'ext/enumerator'
 
 require 'eaternet/lives_1_0'
 require 'eaternet/loggable'
@@ -13,21 +13,21 @@ require 'eaternet/loggable'
 module Eaternet
   module Agencies
     # A data source for New York City food service health inspections.  It
-    # retrieves the latest CSV export from
-    # [the official source](https://data.cityofnewyork.us/Health/DOHMH-New-York-City-Restaurant-Inspection-Results/xx67-kt59)
-    # and makes it easy to work with. The downloaded CSV is cached for twelve
-    # hours in a temporary file.
+    # retrieves the latest CSV export from [the official
+    # source](https://data.cityofnewyork.us/Health/DOHMH-New-York-City-Restaurant-Inspection-Results/xx67-kt59)
+    # and makes it easy to work with.
     #
-    # This library conforms to the
-    # [LIVES 1.0 standard](http://www.yelp.com/healthscores) developed by
-    # Yelp and the cities of San Francisco and New York.
+    # Output is produced in the [LIVES 1.0](http://www.yelp.com/healthscores)
+    # format developed by Yelp and the cities of San Francisco and New York.
+    #
+    # The downloaded CSV is cached for twelve hours in a temporary file.
     #
     # @example Print the names of all the restaurants in New York City
     #   require 'eaternet'
     #   nyc = Eaternet::Nyc.new
     #   puts nyc.businesses.map(&:name)
     #
-    # @example Compute the average inspection score for NYC.
+    # @example Compute the average inspection score
     #   # The library is optimized for memory use at the expense
     #   # of speed. E.g., each call to #inspections will iterate
     #   # through the raw CSV. So here, we first retrieve the
@@ -63,8 +63,8 @@ module Eaternet
       # @return [Enumerable<Business>]
       def businesses
         map_csv { |row| try_to_create_business(row) }
-          .compact
           .unique
+          .compact
       end
 
       # @example Compute the average inspection score for NYC.
@@ -82,21 +82,15 @@ module Eaternet
       #
       # @return [Enumerable<Inspection>]
       def inspections
-        cache = Set.new
-        map_csv do |row|
-          if inspection_should_be_skipped?(cache, row)
-            nil
-          else
-            save_to_inspection_cache(cache, row)
-            try_to_create_inspection(row)
-          end
-        end.compact
+        map_csv { |row| skip_inspection?(row) ? nil : try_to_create_inspection(row) }
+          .unique
+          .compact
       end
 
+      # @return [Enumerable<Violation>]
       def violations
-        map_csv do |row|
-          violation_should_be_skipped?(row) ? nil : violation(row)
-        end.compact
+        map_csv { |row| skip_violation?(row) ? nil : violation(row) }
+          .compact
       end
 
       # @example Print the name & URL of NYC's health agency.
@@ -114,6 +108,7 @@ module Eaternet
         end
       end
 
+      # @return [Enumerable<Legend>]
       def legends
         LegendGroup.new do |lg|
           lg.legends = [
@@ -157,7 +152,7 @@ module Eaternet
         nil
       end
 
-      public  # To enable testing
+      public  # To support testing
 
       # @private
       def business(row)
@@ -180,7 +175,7 @@ module Eaternet
         Violation.new do |v|
           v.business_id = business_id(row)
           v.date = Date.strptime(row['INSPECTION DATE'], '%m/%d/%Y')
-          v.code = violation_kind_id(row)
+          v.code = violation_code(row)
           v.description = row['VIOLATION DESCRIPTION']
         end
       end
@@ -193,34 +188,22 @@ module Eaternet
         end
       end
 
-      def violation_should_be_skipped?(row)
-        transfat_inspection?(row) || violation_kind_id(row).nil?
+      def skip_violation?(row)
+        transfat_inspection?(row) || violation_code(row).nil?
       end
 
-      def inspection_should_be_skipped?(cache, row)
-        cache.include?(inspection_cache_key(row)) || transfat_inspection?(row)
+      def skip_inspection?(row)
+        transfat_inspection?(row)
       end
 
       def business_id(row)
         row['CAMIS']
       end
 
-      def violation_kind_id(row)
+      def violation_code(row)
         row['VIOLATION CODE']
       end
 
-      def save_to_inspection_cache(cache, row)
-        cache.add(inspection_cache_key(row))
-      end
-
-      def inspection_cache_key(row)
-        inspection_id(row)
-      end
-
-      def inspection_id(row)
-        [row['CAMIS'], row['INSPECTION DATE']].join('-')
-      end
-
       def transfat_inspection?(row)
         if row['INSPECTION TYPE']
           row['INSPECTION TYPE'].include?('Trans Fat')
@@ -229,10 +212,10 @@ module Eaternet
         end
       end
 
-      def map_csv(&block)
+      def map_csv(&row_handler)
         CSV.new(File.open(table_file, encoding: 'utf-8'), headers: true)
           .lazy
-          .map { |row| block.call(row) }
+          .map { |row| row_handler.call(row) }
       end
 
       def table_file

data/lib/eaternet/lives_1_0/inspection.rb

@@ -65,6 +65,18 @@ module Eaternet
       def to_s
         "Inspection #{business_id}/#{date}/#{score}"
       end
+
+      def ==(other)
+        business_id == other.business_id && date == other.date
+      end
+
+      def eql?(other)
+        self == other
+      end
+
+      def hash
+        "#{business_id} #{date}".hash
+      end
     end
   end
 end

data/lib/eaternet/lives_1_0/legend.rb

@@ -11,8 +11,6 @@ module Eaternet
     # example, if 80-90 is a ‘B’ and 90-100 is an ‘A’, a score of 90 would be
     # an ‘A’. These are optional.
     #
-    # @see LegendGroup Lives_1_0::LegendGroup, which enforces the 0–100 span and
-    #   checks for overlap.
     # @see http://www.yelp.com/healthscores#legend LIVES / Legend specification
     class Legend < ValidatedObject
       # Minimum score that can be classified with this description.

data/lib/eaternet/lives_1_0/legend_group.rb

@@ -13,6 +13,7 @@ module Eaternet
     #
     # @see http://www.yelp.com/healthscores#legend LIVES / Score Legend
     #   specification
+    # @private
     class LegendGroup < ValidatedObject
       attr_accessor :legends
 

data/lib/eaternet/validated_object.rb

@@ -6,7 +6,7 @@ module Eaternet
   #
   # Uses [ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates)
   # to create self-validating Plain Old Ruby objects. This is especially
-  # useful for data validation when importing from CSV.
+  # useful when importing data from one system into another.
   #
   # @example Writing a self-validating object
   #   class Dog < Eaternet::ValidatedObject
@@ -17,8 +17,8 @@ module Eaternet
   #   end
   #
   # @example Instantiating and automatically validating
-  #   # The dog1 instance is validated at the end of instantiation.
-  #   # Here, it succeeds without exception.
+  #   # The dog1 instance validates itself at the end of instantiation.
+  #   # Here, it succeeds and so doesn't raise an exception.
   #   dog1 = Dog.new do |d|
   #     d.name = 'Spot'
   #   end

data/lib/eaternet/version.rb

@@ -1,3 +1,3 @@
 module Eaternet
-  VERSION = '0.3.14'
+  VERSION = '0.3.15'
 end

data/lib/ext/enumerator.rb

@@ -0,0 +1,13 @@
+class Enumerator
+  # Create a #compact similar to {Array.compact}.
+  #
+  # @return [Enumerator] with {nil}s removed
+  def compact
+    select { |i| !i.nil? }
+  end
+
+  # @return [Enumerator] only my unique elements
+  def unique
+    Set.new(self).each
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eaternet
 version: !ruby/object:Gem::Version
-  version: 0.3.14
+  version: 0.3.15
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -199,7 +199,7 @@ files:
 - lib/eaternet/util.rb
 - lib/eaternet/validated_object.rb
 - lib/eaternet/version.rb
-- lib/ext/lazy.rb
+- lib/ext/enumerator.rb
 - test/eaternet/agencies/nyc_test.rb
 - test/eaternet/agencies/snhd_test.rb
 - test/eaternet/eaternet_test.rb

data/lib/ext/lazy.rb

@@ -1,13 +0,0 @@
-class Enumerator
-  class Lazy
-    # Create a lazy compact similar to Array#compact.
-    def compact
-      select { |i| !i.nil? }
-    end
-
-    # Return only my unique elements
-    def unique
-      Set.new(self).each
-    end
-  end
-end