datapackage 0.2.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18b6d480843853daa822de909d242c78b40ed762
-  data.tar.gz: 4c6004ea6559656434a5759038cc0163c0762520
+  metadata.gz: b986907d114eedf9c0de5138f42b50934f249d7c
+  data.tar.gz: 0a011fae8e6e404b6ca5df4ae1bd878056523930
 SHA512:
-  metadata.gz: e3c5286265b393c7c7ecd3563515bccfb67f2c20a54b6c15e2d4ad1ac00f6c55b69f18c591e38397958a6bf23cd9d0c88deda81ae39e06cf6d8532607f31eeda
-  data.tar.gz: d09058baf930fda7eb99d688f9c9fb405bc1910563d0b1e48763400dc877c27a1540c69eb24e292827e511500612156b37022cbf067622bb2d649fa3e9e9f84b
+  metadata.gz: 3f8747b92725b9c94c70dece7dd38e82b93e5e4151b70d94c66faaed4ae121ef055783afc3a0b81ade12e639ddbb59c88a2f985002b0d48581e89327f7690ee6
+  data.tar.gz: 4f4fae0f01f0ac90f008f0e76fc4875cc35ad54cb195e870920a5b8fae4f24b5026030201737b6a547a720b39e995406a2a6fa7e6a79cd3ee7e2fee7e0df58b6

data/README.md

@@ -1,4 +1,4 @@
-# DataPackage.rb
+# datapackage-rb
 
 [![Travis](https://travis-ci.org/frictionlessdata/datapackage-rb.svg?branch=master)](https://travis-ci.org/frictionlessdata/datapackage-rb)
 [![Coveralls](http://img.shields.io/coveralls/frictionlessdata/datapackage-rb.svg?branch=master)](https://coveralls.io/r/frictionlessdata/datapackage-rb?branch=master)
@@ -100,7 +100,11 @@ first_resource = package.resources[0]
 first_resource = package.get_resource('example')
 
 # Get info about the data source of this resource
-first_resource.source_type
+first_resource.inline?
+first_resource.local?
+first_resource.remote?
+first_resource.multipart?
+first_resource.tabular?
 first_resource.source
 ```
 

data/lib/datapackage/package.rb

@@ -4,7 +4,9 @@ module DataPackage
   class Package < Hash
     include DataPackage::Helpers
 
-    attr_reader :opts, :errors, :profile, :dead_resources
+    # Public
+
+    attr_reader :errors, :profile
 
     # Parse or create a data package
     # Supports reading data from JSON file, directory, and a URL
@@ -24,41 +26,6 @@ module DataPackage
       raise PackageException.new 'Package descriptor is not valid JSON'
     end
 
-    def descriptor
-      self.to_h
-    end
-
-    # Returns the directory for a local file package or base url for a remote
-    # Returns nil for an in-memory object (because it has no base as yet)
-    def base
-      # user can override base
-      return @opts[:base] if @opts[:base]
-      return '' unless @location
-      # work out base directory or uri
-      if local?
-          return File.dirname(@location)
-      else
-          return @location.split('/')[0..-2].join('/')
-      end
-    end
-
-    # Is this a local package? Returns true if created from an in-memory object or a file/directory reference
-    def local?
-      return @local if @local
-      return false if @location =~ /\A#{URI::regexp}\z/
-      true
-    end
-
-    def resources
-      update_resources!
-      self['resources']
-    end
-
-    def resource_names
-      update_resources!
-      self['resources'].map{|res| res.name}
-    end
-
     def valid?
       return false unless @profile.valid?(self)
       return false if self['resources'].map{ |resource| resource.valid? }.include?(false)
@@ -81,6 +48,25 @@ module DataPackage
       errors.each{ |error| yield error }
     end
 
+    def descriptor
+      self.to_h
+    end
+
+    def resources
+      update_resources!
+      self['resources']
+    end
+
+    def resource_names
+      update_resources!
+      self['resources'].map{|res| res.name}
+    end
+
+    def get_resource(resource_name)
+      update_resources!
+      self['resources'].find{ |resource| resource.name == resource_name }
+    end
+
     def add_resource(resource)
       resource = load_resource(resource)
       self['resources'].push(resource)
@@ -100,21 +86,41 @@ module DataPackage
       resource
     end
 
-    def get_resource(resource_name)
-      update_resources!
-      self['resources'].find{ |resource| resource.name == resource_name }
-    end
-
     def save(target=@location)
       update_resources!
       File.open(target, "w") { |file| file << JSON.pretty_generate(self) }
       true
     end
 
+    # Deprecated
+
+    # Returns the directory for a local file package or base url for a remote
+    # Returns nil for an in-memory object (because it has no base as yet)
+    def base
+      # user can override base
+      return @opts[:base] if @opts[:base]
+      return '' unless @location
+      # work out base directory or uri
+      if local?
+          return File.dirname(@location)
+      else
+          return @location.split('/')[0..-2].join('/')
+      end
+    end
+
+    # Is this a local package? Returns true if created from an in-memory object or a file/directory reference
+    def local?
+      return @local if @local
+      return false if @location =~ /\A#{URI::regexp}\z/
+      true
+    end
+
     def property(property, default = nil)
       self[property] || default
     end
 
+    # Private
+
     private
 
     def define_properties!

data/lib/datapackage/profile.rb

@@ -2,7 +2,9 @@ module DataPackage
   class Profile < Hash
     include DataPackage::Helpers
 
-    attr_reader :name, :registry
+    # Public
+
+    attr_reader :name
 
     def initialize(descriptor)
       unless descriptor.is_a?(String)
@@ -24,13 +26,6 @@ module DataPackage
       self.to_h
     end
 
-    # Returns true if there are no errors in data, false if there are
-    def valid?(data)
-      JSON::Validator.validate(self, data)
-    end
-
-    alias :valid :valid?
-
     # Validate data against this profile. Returns true or raises DataPackage::ValidationError
     def validate(data)
       JSON::Validator.validate!(self, data)
@@ -43,13 +38,22 @@ module DataPackage
       JSON::Validator.fully_validate(self, data).each{ |error| yield error }
     end
 
+    # Returns true if there are no errors in data, false if there are
+    def valid?(data)
+      JSON::Validator.validate(self, data)
+    end
+
+    alias :valid :valid?
+
+    # Private
+
     private
 
     def get_profile_from_registry(descriptor)
       @registry = DataPackage::Registry.new
-      profile_metadata = registry.profiles.fetch(descriptor)
+      profile_metadata = @registry.profiles.fetch(descriptor)
       if profile_metadata.fetch('schema_path', nil)
-        profile_path = join_paths(base_path(registry.path), profile_metadata['schema_path'])
+        profile_path = join_paths(base_path(@registry.path), profile_metadata['schema_path'])
       else
         profile_path = profile_metadata['schema']
       end

data/lib/datapackage/resource.rb

@@ -2,7 +2,9 @@ module DataPackage
   class Resource < Hash
     include DataPackage::Helpers
 
-    attr_reader :name, :profile, :source, :source_type, :errors
+    # Public
+
+    attr_reader :errors, :profile, :name, :source
 
     def initialize(resource, base_path = '')
       self.merge! dereference_descriptor(resource, base_path: base_path,
@@ -14,14 +16,48 @@ module DataPackage
       apply_table_defaults! if self.tabular?
     end
 
+    def valid?
+      @profile.valid?(self)
+    end
+
+    alias :valid :valid?
+
+    def validate
+      @profile.validate(self)
+    end
+
+    def iter_errors
+      @profile.iter_errors(self){ |err| yield err }
+    end
+
     def descriptor
       self.to_h
     end
 
-    def table
-      @table ||= TableSchema::Table.new(self.source, self['schema']) if tabular?
+    def inline?
+      @source_type == 'inline'
     end
 
+    alias :inline :inline?
+
+    def local?
+      @source_type == 'local'
+    end
+
+    alias :local :local?
+
+    def remote?
+      @source_type == 'remote'
+    end
+
+    alias :remote :remote?
+
+    def miltipart?
+      false
+    end
+
+    alias :miltipart :miltipart?
+
     def tabular?
       tabular_profile = DataPackage::DEFAULTS[:resource][:tabular_profile]
       return true if @profile.name == tabular_profile
@@ -31,19 +67,11 @@ module DataPackage
 
     alias :tabular :tabular?
 
-    def valid?
-      @profile.valid?(self)
-    end
-
-    alias :valid :valid?
-
-    def validate
-      @profile.validate(self)
+    def table
+      @table ||= TableSchema::Table.new(self.source, self['schema']) if tabular?
     end
 
-    def iter_errors
-      @profile.iter_errors(self){ |err| yield err }
-    end
+    # Private
 
     private
 
@@ -75,12 +103,12 @@ module DataPackage
           field_descriptor['format'] ||= DataPackage::DEFAULTS[:schema][:format]
         end
       end
-
       if self.fetch('dialect', nil)
         DataPackage::DEFAULTS[:dialect].each do |key, val|
           self['dialect'][key.to_s] ||= val
         end
       end
     end
+
   end
 end

data/lib/datapackage/version.rb

@@ -1,3 +1,3 @@
 module DataPackage
-  VERSION = "0.2.6"
+  VERSION = "0.3.1"
 end

data/lib/profiles/data-package.json

@@ -538,4 +538,4 @@
       ]
     }
   }
-}
+}

data/lib/profiles/data-resource.json

@@ -275,4 +275,4 @@
       ]
     }
   }
-}
+}

data/lib/profiles/fiscal-data-package.json

@@ -459,7 +459,7 @@
                             "bareNumber": {
                               "type": "boolean",
                               "title": "bareNumber",
-                              "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
+                              "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
                               "default": true
                             },
                             "decimalChar": {
@@ -588,7 +588,7 @@
                             "bareNumber": {
                               "type": "boolean",
                               "title": "bareNumber",
-                              "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
+                              "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
                               "default": true
                             },
                             "constraints": {
@@ -2462,7 +2462,7 @@
                             "bareNumber": {
                               "type": "boolean",
                               "title": "bareNumber",
-                              "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
+                              "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
                               "default": true
                             },
                             "decimalChar": {
@@ -2591,7 +2591,7 @@
                             "bareNumber": {
                               "type": "boolean",
                               "title": "bareNumber",
-                              "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
+                              "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
                               "default": true
                             },
                             "constraints": {
@@ -4358,4 +4358,4 @@
       }
     }
   ]
-}
+}

data/lib/profiles/registry.json

@@ -41,4 +41,4 @@
     "schema_path": "table-schema.json",
     "specification": "https://specs.frictionlessdata.io/table-schema/"
   }
-]
+]

data/lib/profiles/table-schema.json

@@ -155,7 +155,7 @@
               "bareNumber": {
                 "type": "boolean",
                 "title": "bareNumber",
-                "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
+                "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
                 "default": true
               },
               "decimalChar": {
@@ -284,7 +284,7 @@
               "bareNumber": {
                 "type": "boolean",
                 "title": "bareNumber",
-                "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
+                "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
                 "default": true
               },
               "constraints": {
@@ -1557,4 +1557,4 @@
   "examples": [
     "{\n  \"schema\": {\n    \"fields\": [\n      {\n        \"name\": \"first_name\",\n        \"type\": \"string\"\n        \"constraints\": {\n          \"required\": true\n        }\n      },\n      {\n        \"name\": \"age\",\n        \"type\": \"integer\"\n      },\n    ],\n    \"primaryKey\": [\n      \"name\"\n    ]\n  }\n}\n"
   ]
-}
+}

data/lib/profiles/tabular-data-package.json

@@ -454,7 +454,7 @@
                         "bareNumber": {
                           "type": "boolean",
                           "title": "bareNumber",
-                          "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
+                          "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
                           "default": true
                         },
                         "decimalChar": {
@@ -583,7 +583,7 @@
                         "bareNumber": {
                           "type": "boolean",
                           "title": "bareNumber",
-                          "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
+                          "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
                           "default": true
                         },
                         "constraints": {
@@ -2196,4 +2196,4 @@
       ]
     }
   }
-}
+}

data/lib/profiles/tabular-data-resource.json

@@ -247,7 +247,7 @@
                   "bareNumber": {
                     "type": "boolean",
                     "title": "bareNumber",
-                    "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
+                    "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
                     "default": true
                   },
                   "decimalChar": {
@@ -376,7 +376,7 @@
                   "bareNumber": {
                     "type": "boolean",
                     "title": "bareNumber",
-                    "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
+                    "description": "a boolean field with a default of `true`. If `true` the physical contents of this field must follow the formatting constraints already set out. If `false` the contents of this field may contain leading and/or trailing non-numeric characters (which implementors MUST therefore strip). The purpose of `bareNumber` is to allow publishers to publish numeric data that contains trailing characters such as percentages e.g. `95%` or leading characters such as currencies e.g. `€95` or `EUR 95`. Note that it is entirely up to implementors what, if anything, they do with stripped text.",
                     "default": true
                   },
                   "constraints": {
@@ -1933,4 +1933,4 @@
       ]
     }
   }
-}
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datapackage
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.1
 platform: ruby
 authors:
 - Leigh Dodds
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema