eaternet 0.2.2 → 0.3.0

data/test/loggable_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+require 'eaternet/loggable'
+
+class LoggableTest < Minitest::Test
+  # Test with include because this is how the module
+  # is intended to be used.
+  include Eaternet::Loggable
+
+  def test_creates_and_sends_log_messages_to_stderr
+    assert_output(nil, /Border Collie/) do
+      logger.info('Border Collie')
+    end
+  end
+end

data/test/nyc_adapter_test.rb

@@ -1,22 +1,20 @@
 require 'test_helper'
 
 require 'eaternet'
-require 'eaternet/framework/lives_1_0'
+require 'eaternet/lives_1_0'
 
 CASSETTE = 'nyc'
 MORRIS_PARK_CSV = 'test/fixtures/morris-park-bake-shop.csv'
 
 class NycAdapterTest < Minitest::Test
-  include Eaternet::Framework::Lives_1_0
-
-  @@nyc = Nyc.new(csv_path: MORRIS_PARK_CSV)
+  @@nyc = Eaternet::Nyc.new(csv_path: MORRIS_PARK_CSV)
 
   #
   # Businesses
   #
 
   def test_businesses_returns_an_enumerator_of_business
-    assert enumerable_of? Business, @@nyc.businesses
+    assert enumerable_of? Eaternet::Lives_1_0::Business, @@nyc.businesses
   end
 
   def test_businesses_returns_lives_attributes
@@ -37,7 +35,7 @@ class NycAdapterTest < Minitest::Test
   #
 
   def test_inspections_returns_an_enumerable_of_inspection
-    assert enumerable_of? Inspection, @@nyc.inspections
+    assert enumerable_of? Eaternet::Lives_1_0::Inspection, @@nyc.inspections
   end
 
   # Use the wiki analysis document as a test.
@@ -49,7 +47,7 @@ class NycAdapterTest < Minitest::Test
       09/11/2013
       08/14/2013
       01/24/2013
-      12/31/2012).map{ |d| Date.strptime(d, '%m/%d/%Y')}
+      12/31/2012).map { |d| Date.strptime(d, '%m/%d/%Y') }
     actual_dates = @@nyc.inspections.map(&:date).to_a
     assert_equal expected_dates, actual_dates
   end
@@ -67,7 +65,7 @@ class NycAdapterTest < Minitest::Test
   #
 
   def test_violations_returns_an_enumerable_of_violation
-    assert enumerable_of? Violation, @@nyc.violations
+    assert enumerable_of? Eaternet::Lives_1_0::Violation, @@nyc.violations
   end
 
   def test_violations_returns_lives_attributes
@@ -88,11 +86,10 @@ class NycAdapterTest < Minitest::Test
   #
 
   def test_implements_feed_info
-    assert_instance_of FeedInfo, @@nyc.feed_info
+    assert_instance_of Eaternet::Lives_1_0::FeedInfo, @@nyc.feed_info
   end
 
   def test_has_legends
-    assert_instance_of LegendGroup, @@nyc.legends
+    assert_instance_of Eaternet::Lives_1_0::LegendGroup, @@nyc.legends
   end
-
 end

data/test/snhd_adapter_test.rb

@@ -6,7 +6,19 @@ require 'eaternet'
 SNHD_CASSETTE = 'snhd'
 
 class SnhdAdapterTest < Minitest::Test
-  @@snhd = Snhd.new
+  @@snhd = Eaternet::Snhd.new
+
+  #
+  # Namespace and access
+  #
+
+  def test_global_namespace_not_polluted
+    assert_raises(NameError) { Snhd }
+  end
+
+  #
+  # #businesses
+  #
 
   def test_businesses_returns_an_enumerator
     VCR.use_cassette(SNHD_CASSETTE) do
@@ -16,7 +28,7 @@ class SnhdAdapterTest < Minitest::Test
 
   def test_businesses_returns_business_data_objects
     VCR.use_cassette(SNHD_CASSETTE) do
-      assert_kind_of Eaternet::Framework::Prototype::BusinessData, @@snhd.businesses.first
+      assert_kind_of Eaternet::Prototype::BusinessData, @@snhd.businesses.first
     end
   end
 
@@ -31,6 +43,10 @@ class SnhdAdapterTest < Minitest::Test
     end
   end
 
+  #
+  # #inspections
+  #
+
   def test_inspections_returns_an_enumerable
     VCR.use_cassette(SNHD_CASSETTE) do
       assert_kind_of Enumerable, @@snhd.inspections
@@ -39,7 +55,10 @@ class SnhdAdapterTest < Minitest::Test
 
   def test_inspections_returns_inspection_data_objects
     VCR.use_cassette(SNHD_CASSETTE) do
-      assert_kind_of Eaternet::Framework::Prototype::InspectionData, @@snhd.inspections.first
+      assert_kind_of(
+        Eaternet::Prototype::InspectionData,
+        @@snhd.inspections.first
+      )
     end
   end
 
@@ -53,6 +72,10 @@ class SnhdAdapterTest < Minitest::Test
     end
   end
 
+  #
+  # #violations
+  #
+
   def test_violations_returns_an_enumerable
     VCR.use_cassette(SNHD_CASSETTE) do
       assert_kind_of Enumerable, @@snhd.violations
@@ -61,7 +84,7 @@ class SnhdAdapterTest < Minitest::Test
 
   def test_violations_returns_violation_data_objects
     VCR.use_cassette(SNHD_CASSETTE) do
-      assert_kind_of Eaternet::Framework::Prototype::ViolationData, @@snhd.violations.first
+      assert_kind_of Eaternet::Prototype::ViolationData, @@snhd.violations.first
     end
   end
 
@@ -74,6 +97,10 @@ class SnhdAdapterTest < Minitest::Test
     end
   end
 
+  #
+  # #violation_kinds
+  #
+
   def test_violation_kinds_returns_an_enumerable
     VCR.use_cassette(SNHD_CASSETTE) do
       assert_kind_of Enumerable, @@snhd.violation_kinds
@@ -82,7 +109,10 @@ class SnhdAdapterTest < Minitest::Test
 
   def test_violation_kinds_returns_violation_kind_data_objects
     VCR.use_cassette(SNHD_CASSETTE) do
-      assert_kind_of Eaternet::Framework::Prototype::ViolationKindData, @@snhd.violation_kinds.first
+      assert_kind_of(
+        Eaternet::Prototype::ViolationKindData,
+        @@snhd.violation_kinds.first
+      )
     end
   end
 
@@ -92,8 +122,10 @@ class SnhdAdapterTest < Minitest::Test
       assert_equal '1', v.orig_key
       assert_equal '1', v.code
       assert_equal '6', v.demerits
-      assert_equal 'Food not obtained from approved sources and/or improperly identified.',
-                    v.description
+      assert_equal(
+        'Food not obtained from approved sources and/or improperly identified.',
+        v.description
+      )
     end
   end
 end

data/test/test_helper.rb

@@ -8,6 +8,9 @@ VCR.configure do |c|
 end
 
 
+#
+# Testing helpers
+#
 def enumerable_of?(a_class, obj)
   assert_kind_of Enumerable, obj
   assert_kind_of a_class, obj.first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eaternet
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-minitest
+  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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -145,8 +173,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".inch.yml"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -155,8 +185,9 @@ files:
 - lib/eaternet/agencies/nyc.rb
 - lib/eaternet/agencies/snhd.rb
 - lib/eaternet/agencies/snhd_config.rb
-- lib/eaternet/framework/lives_1_0.rb
-- lib/eaternet/framework/prototype.rb
+- lib/eaternet/lives_1_0.rb
+- lib/eaternet/loggable.rb
+- lib/eaternet/prototype.rb
 - lib/eaternet/util.rb
 - lib/eaternet/version.rb
 - lib/ext/lazy.rb
@@ -166,6 +197,7 @@ files:
 - test/lives_1_0/feed_info_test.rb
 - test/lives_1_0/inspection_test.rb
 - test/lives_1_0/legend_test.rb
+- test/loggable_test.rb
 - test/nyc_adapter_test.rb
 - test/snhd_adapter_test.rb
 - test/test_helper.rb
@@ -200,6 +232,8 @@ test_files:
 - test/lives_1_0/feed_info_test.rb
 - test/lives_1_0/inspection_test.rb
 - test/lives_1_0/legend_test.rb
+- test/loggable_test.rb
 - test/nyc_adapter_test.rb
 - test/snhd_adapter_test.rb
 - test/test_helper.rb
+has_rdoc: 

data/lib/eaternet/framework/lives_1_0.rb

@@ -1,232 +0,0 @@
-module Eaternet
-  module Framework
-
-    # Framework for creating LIVES 1.0 apps.
-    #
-    # The goal is to make it as easy as possible to create
-    # compliant implementations. And so, the Business, Inspection
-    # and Violation data objects use validations to ensure that they
-    # correctly produce the entities listed in the spec.
-    #
-    # @see http://www.yelp.com/healthscores
-    # @see http://yehudakatz.com/2010/01/10/activemodel-make-any-ruby-object-feel-like-activerecord/
-    # @see http://www.rubyinside.com/rails-3-0s-activemodel-how-to-give-ruby-classes-some-activerecord-magic-2937.html
-    module Lives_1_0
-      require 'active_model'
-
-
-      class Adapter
-        # Required.
-        # @return [Enumerable<Business>]
-        def businesses
-          fail 'Override this to return an Enumerable of Business'
-        end
-
-        # Required.
-        # @return [Enumerable<Inspection>]
-        def inspections
-          fail 'Override this to return an Enumerable of Inspection'
-        end
-
-        # Optional.
-        # @return [Enumerable<Violation>]
-        def violations
-          fail 'Optionally override this to return an Enumerable of Violation'
-        end
-
-        # Optional.
-        # @return [FeedInfo]
-        def feed_info
-          fail 'Optionally override this to return a FeedInfo'
-        end
-      end
-
-
-      class DataTransferObject
-        include ActiveModel::Validations
-
-        def initialize(&block)
-          block.call(self)
-          check_validations!
-        end
-
-        def check_validations!
-          fail ArgumentError, errors.messages.inspect if invalid?
-        end
-
-        class TypeValidator < ActiveModel::EachValidator
-          def validate_each(record, attribute, value)
-            record.errors.add attribute, (options[:message] || "is not of class #{options[:with]}") unless
-              value.class == options[:with]
-          end
-        end
-      end
-
-
-      # @see http://www.yelp.com/healthscores#businesses
-      class Business < DataTransferObject
-        attr_accessor :business_id, :name, :address, :city, :state,
-          :postal_code, :latitude, :longitude, :phone_number
-
-        validates :business_id, :name, :address,
-                  type: String,
-                  presence: true
-        validates :city, :state, :postal_code, :phone_number,
-                  type: String,
-                  allow_nil: true
-        validates :latitude,
-                  numericality:
-                    {
-                      greater_than_or_equal_to: -90,
-                      less_than_or_equal_to: 90
-                    },
-                  allow_nil: true
-        validates :longitude,
-                  numericality:
-                    {
-                      greater_than_or_equal_to: -180,
-                      less_than_or_equal_to: 180
-                    },
-                  allow_nil: true
-
-        def ==(other)
-          @business_id == other.business_id
-        end
-
-        def eql?(other)
-          self == other
-        end
-
-        def hash
-          @business_id.hash
-        end
-
-        # @return [String]
-        def to_s
-          "Business #{@business_id}"
-        end
-      end
-
-
-      # @see http://www.yelp.com/healthscores#inspections
-      class Inspection < DataTransferObject
-        attr_accessor :business_id, :score, :date, :description, :type
-
-        ZERO_TO_ONE_HUNDRED_AND_BLANK = (0..100).to_a + ['']
-
-        validates :business_id,
-                  type: String,
-                  presence: true
-        validates :score,
-                  inclusion: { in: ZERO_TO_ONE_HUNDRED_AND_BLANK },
-                  allow_nil: true
-        validates :date,
-                  type: Date,
-                  presence: true
-        validates :type,
-                  inclusion: { in: %w(initial routine followup complaint) },
-                  allow_nil: true
-
-        def score
-          @score.nil? ? '' : @score
-        end
-
-        def to_s
-          "Inspection #{@business_id}/#{@date}/#{@score}"
-        end
-      end
-
-
-      # @see http://www.yelp.com/healthscores#violations
-      class Violation < DataTransferObject
-        attr_accessor :business_id, :date, :code, :description
-
-        validates :business_id,
-                  type: String,
-                  presence: true
-        validates :date,
-                  type: Date,
-                  presence: true
-        validates :code, :description,
-                  type: String,
-                  allow_nil: true
-      end
-
-
-      # @see http://www.yelp.com/healthscores#feed_info
-      class FeedInfo < DataTransferObject
-        attr_accessor :feed_date, :feed_version, :municipality_name,
-                      :municipality_url, :contact_email
-
-        HAS_AN_AT_SOMEWHERE_IN_THE_MIDDLE = /\A[^@]+@[^@]+\z/
-
-        validates :feed_date,
-                  type: Date,
-                  presence: true
-        validates :feed_version,
-                  type: String,
-                  presence: true
-        validates :municipality_name,
-                  type: String,
-                  presence: true
-        validates :municipality_url,
-                  type: String,
-                  format: { with: %r(\Ahttps?:/) },
-                  allow_nil: true
-        validates :contact_email,
-                  type: String,
-                  format: { with: HAS_AN_AT_SOMEWHERE_IN_THE_MIDDLE },
-                  allow_nil: true
-      end
-
-
-      # @see http://www.yelp.com/healthscores#legend
-      class Legend < DataTransferObject
-        attr_accessor :minimum_score, :maximum_score, :description
-
-        validates :minimum_score, :maximum_score,
-                  inclusion: { in: (0..100) }
-        validates :description,
-                  presence: true,
-                  type: String
-      end
-
-
-      # A container for all the Legends in the data set. Performs
-      # validation on the whole set of Legends ensure they cover
-      # the entire range of scores and do not overlap.
-      class LegendGroup < DataTransferObject
-        attr_accessor :legends
-
-        # Check that all the items in this LegendGroup:
-        #
-        #   1. Are of the class, Legend
-        #   2. Cover the range of scores from 0-100 without overlap
-        class ComprehensiveValidator < ActiveModel::EachValidator
-          def validate_each(record, attribute, legends)
-            scores = (0..100).to_a
-            legends.each do |legend|
-              unless legend.class == Legend
-                record.errors.add attribute, 'must be a Legend'
-                return
-              end
-              range = (legend.minimum_score..legend.maximum_score)
-              range.each do |score|
-                if scores.delete(score).nil?
-                  unless score == legend.minimum_score || score == legend.maximum_score
-                    record.errors.add attribute, 'may not overlap'
-                    return
-                  end
-                end
-              end
-            end
-            record.errors.add attribute, 'do not cover entire span from 0–100' unless scores.empty?
-          end
-        end
-
-        validates :legends, comprehensive: true
-      end
-
-    end
-  end
-end