eaternet 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c214305218f45f7fc0f0110e0a20262dc89c1b3
-  data.tar.gz: b3713a441f427f7157999e8152e82a36bc6ac30c
+  metadata.gz: af617767abcfabf9ef5d9db64481d40ff6a4c174
+  data.tar.gz: 157ecfe72159f0bf69fce1482d584d06eec42223
 SHA512:
-  metadata.gz: ace2d1b0f63390feee961ccdabede4f35792d746003726ba676d28f571ca18de77510a11e5f937e2f0f693297280eb2cb9cb3c58974a96bb7047d3e7145bff79
-  data.tar.gz: defe8a3e5cf85ccf3788e6fcb7a298a5e39261eb839b6834ab01f0cda797302926ca89435da362106b44a7e54c5527c9e369877e853e81ee2666fed2504ff7fe
+  metadata.gz: 209c90a1a9bd7e0524dc114624dcaf5ef90af0e26d98582797b80b83702d2fc34cd10b567a7a210dc8b147175566188b6468d52cdd0901d68036db88aed4c772
+  data.tar.gz: cf63bcaf4d071b8f13b9135b26aa2d92eb2cbf93118a340666f9749af5a36b39c9495b6915c0612dc1a72ea12305bf1bcd7642a49e56d630727547f0ca8ec187

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - 2.1
-  - 2.2
+  - 2.2.1
+  - 2.2.2

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in eaternet-adapters.gemspec
+gem 'minitest-utils', git: 'git@github.com:dogweather/minitest-utils.git'
 gemspec

data/eaternet.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'minitest-utils'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10'
   spec.add_development_dependency 'vcr'

data/lib/eaternet/lives_1_0/inspection.rb

@@ -4,62 +4,62 @@ module Eaternet
   module Lives_1_0
     # Information about an inspectors’ visit to a businesses.
     #
-    # @todo Clean up the Yard doc.
     # @see http://www.yelp.com/healthscores#inspections LIVES / Inspections
     #   specification
     class Inspection < ValidatedObject
       ZERO_TO_ONE_HUNDRED_AND_BLANK = (0..100).to_a + ['']
 
       # Unique identifier of the business for which this inspection
-      # was done. Required.
+      # was done.
       #
+      # @required Yes
       # @return [String]
       attr_accessor :business_id
-      validates :business_id,
-                type: String,
-                presence: true
+      validates     :business_id, type: String, presence: true
 
-      # @!attribute [rw] score
-      #   Inspection score on a 0-100 scale. 100 is the highest score.
-      #   This column must always be present in inspections.csv. However, it
-      #   can be safely left blank for inspection rows that don’t have an
-      #   associated score. (For example, some municipalities don’t associate
-      #   a follow-up inspection with a score.)
-      #   @return [Integer] if it's a scored inspection
-      #   @return [String] if it's an un-scored inspection, then the return
-      #     value will be an empty string.
+      # Inspection score on a 0-100 scale. 100 is the highest score. This
+      # column must always be present in inspections.csv. However, it can be
+      # safely left blank for inspection rows that don’t have an associated
+      # score. (For example, some municipalities don’t associate a follow-up
+      # inspection with a score.)
+      #
+      # @required No
+      # @return [Integer] if it's a scored inspection
+      # @return [String] if it's an un-scored inspection, then the return
+      #   value will be an empty string.
       attr_accessor :score
-      validates :score,
-                inclusion: { in: ZERO_TO_ONE_HUNDRED_AND_BLANK },
-                allow_nil: true
+      validates     :score,
+                    inclusion: { in: ZERO_TO_ONE_HUNDRED_AND_BLANK },
+                    allow_nil: true
       def score
         # noinspection RubyResolve
         @score.nil? ? '' : @score
       end
 
-      # @!attribute [rw] date
-      #   Date of the inspection.
-      #   @return [Date]
+      # Date of the inspection.
+      #
+      # @required Yes
+      # @return [Date]
       attr_accessor :date
-      validates :date,
-                type: Date,
-                presence: true
+      validates     :date, type: Date, presence: true
 
-      # @!attribute [rw] description
-      #   Single line description containing details on the outcome of an
-      #   inspection. Use of this field is only encouraged if no violations
-      #   are provided.
-      #   @return [String]
+      # Single line description containing details on the outcome of an
+      # inspection. Use of this field is only encouraged if no violations
+      # are provided.
+      #
+      # @required No
+      # @return [String]
       attr_accessor :description
 
-      # @!attribute [rw] type
-      #   String representing the type of inspection. Must be (initial,
-      #   routine, followup, complaint).
-      #   @return [String]
+      # String representing the type of inspection. Must be (initial,
+      # routine, followup, complaint).
+      #
+      # @required No
+      # @return [String]
       attr_accessor :type
-      validates :type,
-                inclusion: { in: %w(initial routine followup complaint) },
-                allow_nil: true
+      validates     :type,
+                    inclusion: { in: %w(initial routine followup complaint) },
+                    allow_nil: true
 
       # @return [String]
       def to_s

data/lib/eaternet/lives_1_0/violation.rb

@@ -2,19 +2,47 @@ require 'eaternet/validated_object'
 
 module Eaternet
   module Lives_1_0
-    # @todo Document
+    # Contains information about specific violations.
+    #
+    # @required No
     # @see http://www.yelp.com/healthscores#violations LIVES / Violations
     #   specification
     class Violation < ValidatedObject
-      attr_accessor :business_id, :date, :code, :description
-
+      # Unique identifier of the business for which this violation applies
+      #
+      # @required Yes
+      # @return [String]
+      attr_accessor :business_id
       validates :business_id,
                 type: String,
                 presence: true
+
+      # Date of violation. This should correspond with the related inspection.
+      #
+      # @required Yes
+      # @return [Date]
+      attr_accessor :date
       validates :date,
                 type: Date,
                 presence: true
-      validates :code, :description,
+
+      # Code for the violation. It is recommended that this be based on the FDA
+      # Food Code. However, municipalities can decide to use pre-existing codes
+      # for this field.
+      #
+      # @required No
+      # @return [String]
+      attr_accessor :code
+      validates :code,
+                type: String,
+                allow_nil: true
+
+      # One line description of the violation.
+      #
+      # @required No
+      # @return [String]
+      attr_accessor :description
+      validates :description,
                 type: String,
                 allow_nil: true
     end

data/lib/eaternet/validated_object.rb

@@ -5,8 +5,8 @@ module Eaternet
   #   to create custom validating objects.
   #
   # 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.
+  # to create self-validating Plain Old Ruby objects. This is especially
+  # useful for data validation when importing from CSV.
   #
   # @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 is validated at the end of instantiation.
+  #   # Here, it succeeds without exception.
   #   dog1 = Dog.new do |d|
   #     d.name = 'Spot'
   #   end
@@ -55,11 +55,12 @@ module Eaternet
     # Run any validations and raise an error if invalid.
     # @raise [ArgumentError] if any validations fail.
     def check_validations!
-      fail ArgumentError, errors.messages.inspect if invalid?
+      fail ArgumentError, errors.full_messages.join('; ') if invalid?
     end
 
     # A custom validator which ensures an object is a certain class.
-    # It's here as a nested class in {ValidatedObject} for easy access by subclasses.
+    # It's here as a nested class in {ValidatedObject} for easy
+    # access by subclasses.
     #
     # @example Ensure that weight is a floating point number
     #   class Dog < ValidatedObject
@@ -69,10 +70,12 @@ module Eaternet
     class TypeValidator < ActiveModel::EachValidator
       # @return [nil]
       def validate_each(record, attribute, value)
-        return if value.class == options[:with]
+        expected = options[:with]
+        actual = value.class
+        return if actual == expected
 
-        message = options[:message] || "is not of class #{options[:with]}"
-        record.errors.add attribute, message
+        msg = options[:message] || "is class #{actual}, not #{expected}"
+        record.errors.add attribute, msg
       end
     end
   end

data/lib/eaternet/version.rb

@@ -1,3 +1,3 @@
 module Eaternet
-  VERSION = '0.3.5'
+  VERSION = '0.3.6'
 end

data/test/eaternet/lives_1_0/business_test.rb

@@ -9,7 +9,7 @@ class BusinessTest < Minitest::Test
 
   PORTLAND_OR_US = { lat: 45.5236111, lon: -122.675 }
 
-  def test_business_without_lat_and_lon
+  def test_creates_business_without_lat_and_lon
     business = Eaternet::Lives_1_0::Business.new do |i|
       i.business_id = '789123hjd'
       i.name = 'Starbucks'
@@ -18,7 +18,7 @@ class BusinessTest < Minitest::Test
     refute_nil business
   end
 
-  def test_business_rejects_lat_and_lon_which_are_not_numbers
+  def test_rejects_lat_and_lon_which_are_not_numbers
     assert_raises(ArgumentError) {
       Eaternet::Lives_1_0::Business.new do |i|
         i.business_id = '789123hjd'
@@ -30,7 +30,7 @@ class BusinessTest < Minitest::Test
     }
   end
 
-  def test_business_with_lat_and_lon
+  def test_creates_business_with_lat_and_lon
     business = Eaternet::Lives_1_0::Business.new do |i|
       i.business_id = '789123hjd'
       i.name = 'Starbucks'
@@ -41,7 +41,7 @@ class BusinessTest < Minitest::Test
     refute_nil business
   end
 
-  def test_business_rejects_invalid_latitude
+  def test_rejects_invalid_latitude
     assert_raises(ArgumentError) {
       Eaternet::Lives_1_0::Business.new do |i|
         i.business_id = '789123hjd'
@@ -53,7 +53,7 @@ class BusinessTest < Minitest::Test
     }
   end
 
-  def test_business_rejects_invalid_longitude
+  def test_rejects_invalid_longitude
     assert_raises(ArgumentError) {
       Eaternet::Lives_1_0::Business.new do |i|
         i.business_id = '789123hjd'
@@ -69,7 +69,7 @@ class BusinessTest < Minitest::Test
   # Business#name
   #
 
-  def test_business_rejects_blank_name
+  def test_rejects_blank_name
     assert_raises(ArgumentError) {
       Eaternet::Lives_1_0::Business.new do |i|
         i.business_id = '789123hjd'

data/test/script.rb

@@ -0,0 +1,43 @@
+require 'date'
+require 'eaternet/validated_object'
+
+# @example Writing a self-validating object
+#   class Dog < Eaternet::ValidatedObject
+#     attr_accessor :name, :birthday
+#
+#     validates :name, presence: true
+#     validates :birthday, type: Date, allow_nil: true
+#   end
+#
+# @example Instantiating and automatically validating
+#   # The dog1 instance is validated at the end of instantiation.
+#   # Here, it succeeds without exception.
+#   dog1 = Dog.new do |d|
+#     d.name = 'Spot'
+#   end
+#
+#   # We can also explicitly test for validity
+#   dog1.valid?  # => true
+#
+#   dog1.birthday = Date.new(2015, 1, 23)
+#   dog1.valid?  # => true
+#
+# @example Making an instance invalid
+#   dog1.birthday = '2015-01-23'
+#   dog1.valid?  # => false
+#   dog1.check_validations!  # => ArgumentError: birthday is not of class Date
+
+class Dog < Eaternet::ValidatedObject
+  attr_accessor :name, :birthday
+
+  validates :name, presence: true
+  validates :birthday, type: Date, allow_nil: true
+end
+
+dog1 = Dog.new do |d|
+  d.name = 'Spot'
+end
+puts "dog1.valid? #{dog1.valid?}"
+
+dog1.birthday = '2015-01-23'
+dog1.check_validations!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eaternet
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-utils
-  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -209,6 +195,7 @@ files:
 - test/eaternet/nyc_adapter_test.rb
 - test/eaternet/snhd_adapter_test.rb
 - test/fixtures/morris-park-bake-shop.csv
+- test/script.rb
 - test/test_helper.rb
 homepage: https://github.com/eaternet/adapters-ruby
 licenses:
@@ -230,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Regional adapters for restaurant health scores
@@ -244,5 +231,6 @@ test_files:
 - test/eaternet/nyc_adapter_test.rb
 - test/eaternet/snhd_adapter_test.rb
 - test/fixtures/morris-park-bake-shop.csv
+- test/script.rb
 - test/test_helper.rb
 has_rdoc: