inat-get 0.8.0.11 → 0.8.0.13

data/lib/inat/data/entity/observationsound.rb

@@ -6,15 +6,14 @@ require_relative '../types/std'
 require_relative '../types/extras'
 require_relative '../entity'
 
-# require_relative 'observation'
-# require_relative 'sound'
-
-# class Observation < Entity; end
+module INat::Entity
+  autoload :Observation, 'inat/data/entity/observation'
+  autoload :Sound,       'inat/data/entity/sound'
+end
 
-autoload :Observation, 'inat/data/entity/observation'
-autoload :Sound,       'inat/data/entity/sound'
+class INat::Entity::ObservationSound < INat::Data::Entity
 
-class ObservationSound < Entity
+  include INat::Entity
 
   table :observation_sounds
 

data/lib/inat/data/entity/photo.rb

@@ -4,13 +4,19 @@ require_relative '../types/std'
 require_relative '../types/extras'
 require_relative '../entity'
 
-autoload :Observation, 'inat/data/entity/observation'
+module INat::Entity
+  autoload :Observation, 'inat/data/entity/observation'
+  autoload :Flag,        'inat/data/entity/flag'
+end
+
+class INat::Entity::Photo < INat::Data::Entity
 
-class Photo < Entity
+  include INat::Data::Types
+  include INat::Entity
 
   table :photos
 
-  field :license_code, type: Symbol, index: true
+  field :license_code, type: LicenseCode, index: true
   field :url, type: URI, required: true
   field :square_url, type: URI
   field :medium_url, type: URI

data/lib/inat/data/entity/place.rb

@@ -5,9 +5,14 @@ require_relative '../types/extras'
 require_relative '../types/location'
 require_relative '../entity'
 
-autoload :Observation, 'inat/data/entity/observation'
+module INat::Entity
+  autoload :Observation, 'inat/data/entity/observation'
+end
+
+class INat::Entity::Place < INat::Data::Entity
 
-class Place < Entity
+  include INat::Data::Types
+  include INat::Entity
 
   extend BySLUG
 
@@ -17,6 +22,8 @@ class Place < Entity
 
   table :places
 
+  # @!group Fields
+
   field :uuid, type: UUID, unique: true
   field :name, type: String, index: true, required: true
   field :slug, type: Symbol, index: true
@@ -31,6 +38,8 @@ class Place < Entity
 
   links :ancestor_places, item_type: Place, table_name: :place_ancestors, link_field: :ancestor_id, index: true
 
+  # @!endgroup
+
   def === other
     self.id == other.id && other.ancestor_place_ids.include?(self.id)
   end

data/lib/inat/data/entity/project.rb

@@ -6,18 +6,20 @@ require_relative '../types/location'
 require_relative '../entity'
 require_relative '../enums/projecttype'
 
-# require_relative 'projectadmin'
-# require_relative 'projectobservationrule'
+module INat::Entity
+  autoload :Observation,            'inat/data/entity/observation'
+  autoload :User,                   'inat/data/entity/user'
+  autoload :Place,                  'inat/data/entity/place'
+  autoload :ProjectAdmin,           'inat/data/entity/projectadmin'
+  autoload :ProjectObservationRule, 'inat/data/entity/projectobservationrule'
+  autoload :Flag,                   'inat/data/entity/flag'
+  autoload :Taxon,                  'inat/data/entity/taxon'
+end
 
-autoload :Observation,            'inat/data/entity/observation'
-autoload :User,                   'inat/data/entity/user'
-autoload :Place,                  'inat/data/entity/place'
-autoload :ProjectAdmin,           'inat/data/entity/projectadmin'
-autoload :ProjectObservationRule, 'inat/data/entity/projectobservationrule'
-autoload :Flag,                   'inat/data/entity/flag'
-autoload :Taxon,                  'inat/data/entity/taxon'
+class INat::Entity::Project < INat::Data::Entity
 
-class Project < Entity
+  include INat::Data::Types
+  include INat::Entity
 
   extend BySLUG
 
@@ -27,6 +29,8 @@ class Project < Entity
 
   table :projects
 
+  # @!group Fields
+
   field :slug, type: Symbol, index: true
   field :title, type: String, index: true, required: true
   field :description, type: String
@@ -87,6 +91,8 @@ class Project < Entity
   ignore :search_parameters
   ignore :rule_preferences
 
+  # @!endgroup
+
   def to_s
     "<a href=\"https://www.inaturalist.org/projects/#{ id }\"><i class=\"fa fa-briefcase\"></i>  #{ title }</a>"
   end

data/lib/inat/data/entity/projectadmin.rb

@@ -5,12 +5,12 @@ require_relative '../types/extras'
 require_relative '../entity'
 require_relative '../enums/projectadminrole'
 
-# require_relative 'project'
-# autoload :Project, 'inat/data/entity/project'
+class INat::Entity::Project < INat::Data::Entity; end
 
-class Project < Entity; end
+class INat::Entity::ProjectAdmin < INat::Data::Entity
 
-class ProjectAdmin < Entity
+  include INat::Data::Types
+  include INat::Entity
 
   table :project_admins
 

data/lib/inat/data/entity/projectobservationrule.rb

@@ -4,12 +4,11 @@ require_relative '../types/std'
 require_relative '../types/extras'
 require_relative '../entity'
 
-# require_relative 'project'
-# autoload :Project, 'inat/data/entity/project'
+class INat::Entity::Project < INat::Data::Entity; end
 
-class Project < Entity; end
+class INat::Entity::ProjectObservationRule < INat::Data::Entity
 
-class ProjectObservationRule < Entity
+  include INat::Entity
 
   table :project_observation_rules
 

data/lib/inat/data/entity/request.rb

@@ -5,10 +5,14 @@ require_relative '../types/extras'
 require_relative '../entity'
 require_relative '../db'
 
-autoload :Observation, 'inat/data/entity/observation'
-autoload :Project,     'inat/data/entity/project'
+module INat::Entity
+  autoload :Observation, 'inat/data/entity/observation'
+  autoload :Project,     'inat/data/entity/project'
+end
+
+class INat::Entity::Request < INat::Data::Entity
 
-class Request < Entity
+  include INat::Entity
 
   table :requests
 

data/lib/inat/data/entity/sound.rb

@@ -4,9 +4,14 @@ require_relative '../types/std'
 require_relative '../types/extras'
 require_relative '../entity'
 
-autoload :Observation, 'inat/data/entity/observation'
+module INat::Entity
+  autoload :Observation, 'inat/data/entity/observation'
+end
+
+class INat::Entity::Sound < INat::Data::Entity
 
-class Sound < Entity
+  include INat::Data::Types
+  include INat::Entity
 
   table :sounds
 

data/lib/inat/data/entity/taxon.rb

@@ -9,10 +9,14 @@ require_relative '../enums/iconictaxa'
 
 require_relative 'photo'
 
-autoload :Observation, 'inat/data/entity/observation'
-# autoload :Photo,       'inat/data/entity/photo'
+module INat::Entity
+  autoload :Observation, 'inat/data/entity/observation'
+end
+
+class INat::Entity::Taxon < INat::Data::Entity
 
-class Taxon < Entity
+  include INat::Data::Types
+  include INat::Entity
 
   api_path :taxa
   api_part :query
@@ -20,6 +24,8 @@ class Taxon < Entity
 
   table :taxa
 
+  # @!group Fields
+
   field :is_active, type: Boolean, index: true
   # field :ancestry, type: Ancestry
   # field :min_species_ancestry, type: Ancestry
@@ -71,6 +77,8 @@ class Taxon < Entity
   ignore :observations_count
   ignore :universal_search_rank
 
+  # @!endgroup
+
   def === other
     other.id == self.id || other.ancestor_ids.include?(self.id)
   end

data/lib/inat/data/entity/user.rb

@@ -4,9 +4,13 @@ require_relative '../types/std'
 require_relative '../types/extras'
 require_relative '../entity'
 
-autoload :Observation, 'inat/data/entity/observation'
+module INat::Entity
+  autoload :Observation, 'inat/data/entity/observation'
+end
+
+class INat::Entity::User < INat::Data::Entity
 
-class User < Entity
+  include INat::Entity
 
   api_path :users
   api_part :path
@@ -48,7 +52,7 @@ class User < Entity
       results = from_db_rows data
     end
     if results.empty?
-      data = API.query 'users/autocomplete', first_only: true, q: login
+      data = INat::API.query 'users/autocomplete', first_only: true, q: login
       results = data.select { |u| u['login'] == login.to_s }.map { |d| parse(d) }
     end
     if results.empty?

data/lib/inat/data/entity/vote.rb

@@ -4,10 +4,14 @@ require_relative '../types/std'
 require_relative '../types/extras'
 require_relative '../entity'
 
-autoload :Observation, 'inat/data/entity/observation'
-autoload :User,        'inat/data/entity/user'
+module INat::Entity
+  autoload :Observation, 'inat/data/entity/observation'
+  autoload :User,        'inat/data/entity/user'
+end
+
+class INat::Entity::Vote < INat::Data::Entity
 
-class Vote < Entity
+  include INat::Entity
 
   table :votes
 

data/lib/inat/data/entity.rb

@@ -7,17 +7,21 @@ require_relative 'ddl'
 require_relative 'db'
 require_relative 'api'
 
-class Entity < Model
+class INat::Data::Entity < INat::Data::Model
 
-  include LogDSL
+  include INat
+  include INat::App::Logger::DSL
 
   class << self
 
-    include LogDSL
+    using INat::Types::Std
+
+    include INat
+    include INat::App::Logger::DSL
 
     def inherited sub
       sub.send :init
-      DDL << sub
+      Data::DDL << sub
     end
 
     private :new
@@ -115,7 +119,7 @@ class Entity < Model
 
     def load *ids
       return [] if ids.empty? || @api_path.nil?
-      data = API.get @api_path, @api_part, @api_limit, *ids
+      data = INat::API.get @api_path, @api_part, @api_limit, *ids
       data.map { |obj| parse obj }
     end
 
@@ -172,8 +176,12 @@ class Entity < Model
 
   end
 
+  # @!group Fields
+
   field :id, type: Integer, primary_key: true
 
+  # @!endgroup
+
   def initialize id
     super()
     self.id = id
@@ -201,7 +209,7 @@ class Entity < Model
         case field.kind
         when :value
           value = self.send(field.name)
-          if Entity === value && value != self # && !value.process?
+          if INat::Entity === value && value != self # && !value.process?
             value.save
           end
           name, value = field.to_db value
@@ -266,26 +274,32 @@ class Entity < Model
 
 end
 
-module BySLUG
+module INat::Entity
 
-  def by_slug slug
-    # Status::status '[fetch]', "#{ self } : #{ slug } ..."
-    @entities ||= {}
-    results = @entities.values.select { |e| e.slug == slug.intern }
-    if results.empty?
-      data = DB.execute "SELECT * FROM #{ table } WHERE slug = ?", slug.to_s
-      results = from_db_rows data
-    end
-    if results.empty?
-      data = API.get @api_path, :path, 1, slug
-      results = data.map { |d| parse(d) }
-    end
-    # Status::status '[fetch]', "#{ self } : #{ slug } DONE"
-    if results.empty?
-      nil
-    else
-      results.first
+  module BySLUG
+
+    include INat
+
+    def by_slug(slug)
+      # Status::status '[fetch]', "#{ self } : #{ slug } ..."
+      @entities ||= {}
+      results = @entities.values.select { |e| e.slug == slug.intern }
+      if results.empty?
+        data = DB.execute "SELECT * FROM #{table} WHERE slug = ?", slug.to_s
+        results = from_db_rows data
+      end
+      if results.empty?
+        data = INat::API.get @api_path, :path, 1, slug
+        results = data.map { |d| parse(d) }
+      end
+      # Status::status '[fetch]', "#{ self } : #{ slug } DONE"
+      if results.empty?
+        nil
+      else
+        results.first
+      end
     end
+
   end
 
 end

data/lib/inat/data/enums/conservationstatus.rb

@@ -2,7 +2,9 @@
 
 require 'extra/enum'
 
-class CS < Enum
+module INat::Data::Types; end
+
+class INat::Data::Types::ConservationStatus < Enum
 
   item :NE, data:  0
   item :DD, data:  5
@@ -26,5 +28,3 @@ class CS < Enum
 
   freeze
 end
-
-ConservationStatus = CS

data/lib/inat/data/enums/geoprivacy.rb

@@ -2,7 +2,9 @@
 
 require 'extra/enum'
 
-class GeoPrivacy < Enum
+module INat::Data::Types; end
+
+class INat::Data::Types::GeoPrivacy < Enum
 
   items :open,
         :obscured,

data/lib/inat/data/enums/iconictaxa.rb

@@ -2,7 +2,7 @@
 
 require 'extra/enum'
 
-class IconicTaxa < Enum
+class INat::Data::Types::IconicTaxa < Enum
 
   items :Aves,
         :Amphibia,

data/lib/inat/data/enums/identificationcategory.rb

@@ -2,7 +2,7 @@
 
 require 'extra/enum'
 
-class IdentificationCategory < Enum
+class INat::Data::Types::IdentificationCategory < Enum
 
   items :improving,
         :supporting,

data/lib/inat/data/enums/licensecode.rb

@@ -2,7 +2,9 @@
 
 require 'extra/enum'
 
-class LicenseCode < Enum
+module INat::Data::Types; end
+
+class INat::Data::Types::LicenseCode < Enum
 
   items :'cc0',
         :'cc-by',
@@ -10,7 +12,8 @@ class LicenseCode < Enum
         :'cc-by-nd',
         :'cc-by-sa',
         :'cc-by-nc-nd',
-        :'cc-by-nc-sa'
+        :'cc-by-nc-sa',
+        :'pd'
 
   freeze
 end

data/lib/inat/data/enums/projectadminrole.rb

@@ -2,7 +2,7 @@
 
 require 'extra/enum'
 
-class ProjectAdminRole < Enum
+class INat::Data::Types::ProjectAdminRole < Enum
 
   items :curator,
         :manager

data/lib/inat/data/enums/projecttype.rb

@@ -2,7 +2,9 @@
 
 require 'extra/enum'
 
-class ProjectType < Enum
+# TODO: подумать над занесением внутрь Project
+
+class INat::Data::Types::ProjectType < Enum
 
   items :collection,
         :umbrella,
@@ -17,7 +19,7 @@ class ProjectType < Enum
 
     def parse src
       if src == ''
-        return ProjectType::MANUAL
+        return MANUAL
       else
         super src
       end
@@ -26,7 +28,7 @@ class ProjectType < Enum
   end
 
   def to_s
-    if self == ProjectType::MANUAL
+    if self == MANUAL
       return ''
     else
       super

data/lib/inat/data/enums/qualitygrade.rb

@@ -2,7 +2,7 @@
 
 require 'extra/enum'
 
-class QualityGrade < Enum
+class INat::Data::Types::QualityGrade < Enum
 
   items :research,
         :needs_id,

data/lib/inat/data/enums/rank.rb

@@ -2,7 +2,7 @@
 
 require 'extra/enum'
 
-class Rank < Enum
+class INat::Data::Types::Rank < Enum
 
   item :stateofmatter, data: 100
   item :kingdom,       data:  70