arduino-library 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32c6c38ed6001c70620f9a72bc1baad8b5d82a2c
-  data.tar.gz: '0791f871e9b87f0ed40bbac061d88baaab67cd69'
+  metadata.gz: 238adfe1709888149a3316933804737c16d5d696
+  data.tar.gz: d44086c49e7b5d41306ba1b9e2fde18c83a8dc1f
 SHA512:
-  metadata.gz: 4105c73cb121404bc8311070e581f32b95d7efa1ea3b313b0b3d10431d7846aa3e09c3de916ba5766c14b068f2dd12adc63b43c615f27aad3fc238df27d16890
-  data.tar.gz: e0e1d7e66476d4e06ae7b974ae03f7b1adc34c0e345aa584206159ecedc718877d4cb028cb42f171f9938fdaa06b59ce3f995209d6d460eaf994466300b66de8
+  metadata.gz: 4d111c2a09af56569e48573375c00b46a2143d592de8fd164b66fa4bc6f9094611f2416e3edfefa7f365933eee39517468169c59d66d607a91a855d350c78bfe
+  data.tar.gz: e06b0c34cbf08cb2413fab35e6d0102044ea3259b3edc6444f926115dc65f2b433f2bf28aeb47351e3fdbfeec7e6c496a7f459729da60f403b6f457527471233

data/README.md

@@ -87,7 +87,7 @@ There are two ways to include the DSL in your context:
 ```ruby
 require 'arduino/library'
 class Foo
-  include Arduino::Library::InstanceMethods
+  include Arduino::Library
 end
 ```
 

data/lib/arduino/library.rb

@@ -26,7 +26,15 @@ require 'arduino/library/instance_methods'
 
 module Arduino
   module Library
-    include InstanceMethods
+    class << self
+      def included(base)
+        base.include(::Arduino::Library::InstanceMethods)
+        base.include(::Arduino::Library::Finder::FinderMethods)
+      end
+
+      included(Arduino::Library)
+    end
+
   end
 end
 

data/lib/arduino/library/finder.rb

@@ -11,11 +11,9 @@ module Arduino
     # query based this information. If multiple entries returned,
     # but for the same library, the latest version is returned.
     module Finder
-      class << self
-        include ::Arduino::Library::InstanceMethods
-
+      module FinderMethods
         # Finds a given model with only partial data by
-        # searching in the Ardiuino Database.
+        # searching in the Arduino Database.
         #
         #      model = Arduino::Library::Finder.find({ name: 'AudioZero'} )
         #      # => <Arduino::Library::Model#0x3242gfa2...>
@@ -24,18 +22,21 @@ module Arduino
         #
         # @param [Model] model with a partial information only, such as the name.
         # @return [Model] a found model with #url provided, if found, nil otherwise.
-        def find(model)
+        def find_library(model, version: :latest)
           raise ArgumentError, 'Model argument is required' unless model
-
           model = Model.from(model) unless model.is_a?(Model)
-          return model unless model.partial?
+          return model unless model&.partial?
 
           query = construct_query(model)
           return nil if query.empty?
 
-          latest_version_by(query)
+          get_library_version(query, version: version)
         end
 
+        alias find find_library
+
+        private
+
         # Given a model with partial information, constructs a query
         # by name and version.
         # @param [Model] model a library model with name, and optionally version
@@ -52,7 +53,7 @@ module Arduino
         #
         # @param [Hash] query model attributes to search for, eg, +name: 'AudioZero'
         # @return <Model>  search result, or the most recent version if many match
-        def latest_version_by(query)
+        def get_library_version(query, version: :latest)
           results = if query.key?(:name)
                       Model.find(**query).sort
                     else
@@ -60,9 +61,25 @@ module Arduino
                     end
           return nil if results.size == 0
           return results.first if results.size == 1
-          results.last
+
+          if version == :latest
+            results.last
+          elsif version == :oldest
+            results.last
+          elsif version =~ /^[0-9.]*$/
+            results.find { |r| r.version == version }
+          else
+            raise ArgumentError, "Invalid version specified in arguments — #{version}." +
+                "Expecting either :latest, :oldest, or a specific version number."
+          end
         end
       end
+
+
+      class << self
+        include ::Arduino::Library::InstanceMethods
+        include ::Arduino::Library::Finder::FinderMethods
+      end
     end
   end
 end

data/lib/arduino/library/include.rb

@@ -1,3 +1,3 @@
 require 'arduino/library'
 
-include Arduino::Library::InstanceMethods
+include Arduino::Library

data/lib/arduino/library/model.rb

@@ -27,7 +27,7 @@ module Arduino
       def version_to_i
         if version
           first, second, third = version.split(/\./).map(&:to_i)
-          10**6 * (first || 0) + 10**3 * (second || 0) + (third || 0)
+          10 ** 6 * (first || 0) + 10 ** 3 * (second || 0) + (third || 0)
         else
           0
         end
@@ -37,7 +37,7 @@ module Arduino
 
       # @returns true if the library has enough data to be searched in the db
       def partial?
-        self.url.nil? && SEARCHABLE_FIELDS.any?{ |field| self.send(field) }
+        self.url.nil? && SEARCHABLE_FIELDS.any? { |field| self.send(field) }
       end
 
       def <=>(another)
@@ -110,40 +110,48 @@ module Arduino
         #   ends
         #
         # @return [Model | Array<Model> ] — array for search, otherwise a model
-        def from(source = nil, ** opts)
-          model = case source
-                    when Hash
-                      from_hash(source)
-                    when String
-                      if source =~ /^{/m
-                        from_json(source)
-                      elsif File.exist?(source)
-                        if source =~ /\.json(\.gz)?$/i
-                          from_json_file(source)
-                        elsif source =~ /\.properties(\.gz)?$/i
-                          from_properties_file(source)
-                        end
-                      end
-                    when NilClass
-                      if opts
-                        if SEARCHABLE_FIELDS.any?{ |field| opts[field] }
-                          results = search(**opts)
-                          if results
-                            results.sort.last
-                          else
-                            nil
-                          end
-                        else
-                          from_hash(opts)
-                        end
-                      end
-                  end
+        def from(source = nil, **opts)
+          model = model_by_class(source, **opts)
           if model&.partial?
-            Finder.find(model)
+            Finder.find_library(model)
           else
             model
           end
         end
+
+        private
+
+        def model_by_class(source, **opts)
+          case source
+            when Hash
+              from_hash(source)
+            when String
+              if source =~ /^{/m
+                from_json(source)
+              elsif File.exist?(source)
+                if source =~ /\.json(\.gz)?$/i
+                  from_json_file(source)
+                elsif source =~ /\.properties(\.gz)?$/i
+                  from_properties_file(source)
+                end
+              end
+            when NilClass
+              if opts
+                if SEARCHABLE_FIELDS.any? { |field| opts[field] }
+                  results = search(**opts)
+                  if results
+                    results.sort.last
+                  else
+                    nil
+                  end
+                else
+                  from_hash(opts)
+                end
+              end
+            else
+              nil
+          end
+        end
       end
     end
   end

data/lib/arduino/library/version.rb

@@ -1,6 +1,6 @@
 module Arduino
   module Library
-    VERSION = '0.5.5'
+    VERSION = '0.6.0'
     DESCRIPTION = <<-eof
     This library provides a convenient ruby API for representation of an Arduino Library specification, including field and type validation, reading and writing the library.properties file, as well as downloading the official database of Arduino libraries, and offering a highly advanced searching functionality. This gem only offers Ruby API, but for command line usage please checkout the gem called "arli" — Arduino Library Dependency Manager that uses this library behind the scenes.
     eof

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino-library
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable