arduino-library 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88454f721c5525155a7c7c211b3ad5be0ff9bd18
-  data.tar.gz: 1bbec07173a6e26da1f04068aaaeb9a38f39611e
+  metadata.gz: 3b5c76ad31ff11fa46db661d9c15bdd0491d371a
+  data.tar.gz: 15c6b0b9857623d65d41bd3f6b0364f42ffc34c6
 SHA512:
-  metadata.gz: 6be6be182453fc56d7c34a3d2698e6a643dbd7b3f10b209f4b5c686bac9924b5f6c61bc2d1f63aa96978eebd279644f9d8ae6479760d9275c5d136d4d1279a2d
-  data.tar.gz: 6f6694663d6516970d0d36d96ffc3918c795706df451a1b76ec9fa016af83119137776324e9bf2405c3a951ab466838f5ba8479e3e46f989897be883a763284b
+  metadata.gz: 233b52e36e5128b7ca9dc5373d5d2f5254e79c25226261d8c0cbbdaf5257275b1d2649e1fcddfc83f1928fc94274826b94ed26cdc8775f68fb9cdaee4930dbfa
+  data.tar.gz: 4ccc781670970f5ba2178842e08cbe9233c5415c8bf226e8e5b26e7b08ac364449b980a3a33802c93b2ee6e65018fb611ecf146cd11622ff27fa0f2a17ef27e2

data/README.md

@@ -36,6 +36,49 @@ Or install it yourself as:
 Current version only contains Ruby-based API and is meant to be consumed by other projects (in particularly, check out [Arli](https://github.com/kigster/arli) — a command-line tool and an Arduino Library Manager and installer). This project is invaluable if you are you using, for example, [arduino-cmake](https://github.com/arduino-cmake/arduino-cmake) project to build and upload your Arduino Code.
 
 
+### Configuration
+
+The gem database can be configured to download the default database from a custom URL, 
+keep a local cache in a custom file. It always downloads the index locally, and next time
+it's invoked, the local file is used (if and only if it's size is identical 
+to the remote file).
+
+You can change the configuration in two ways:
+
+ 1. Set environment variables before invoking the gem
+ 2. Configure the `DefaultDatabase` class variables
+
+#### Environment Variables
+
+ * `ARDUINO_CUSTOM_LIBRARY_PATH` can be used to change local top-level path to the libraries folder.
+ * `ARDUINO_LIBRARY_INDEX_PATH` can be used to change the location of the cached index file.
+
+#### Class Variables
+
+```ruby
+require 'arduino/library'
+Arduino::Library::DefaultDatabase.library_index_path =
+Arduino::Library::DefaultDatabase.library_index_url  =
+Arduino::Library::DefaultDatabase.library_path       =
+
+# then reload the database:
+Arduino::Library::DefaultDatabase.instance.setup
+```
+
+#### Default Values:
+
+```ruby
+DEFAULT_ARDUINO_LIBRARY_INDEX_URL  =
+   'http://downloads.arduino.cc/libraries/library_index.json.gz'
+   
+DEFAULT_ARDUINO_LIBRARY_PATH       =
+    ENV['ARDUINO_CUSTOM_LIBRARY_PATH'] || (ENV['HOME'] + '/Documents/Arduino/Libraries')
+
+DEFAULT_ARDUINO_LIBRARY_INDEX_PATH =
+    ENV['ARDUINO_LIBRARY_INDEX_PATH'] ||
+    (ENV['HOME'] + '/Documents/Arduino/Libraries/index.json.gz')
+```
+
 ### Using the top-level module
 
 If you prefer not to have hard-coded dependencies on the `Arduino::Library::*` sub-classes and sub-modules, you can use the top level module, which proxies several shortcut methods.
@@ -146,7 +189,7 @@ database = Arduino::Library::Database.from(
 or, since the above link happens to be the default location of Arduino-maintained librarie index file, you can use the `default` method instead:
 
 ```ruby
-database = Arduino::Library::Database.default
+database = Arduino::Library::DefaultDatabase.instance
 ```
 
 or, load the list from a local JSON file, that can be optionally gzipped (just like the URL):

data/arduino-library.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dry-configurable'
   spec.add_dependency 'dry-types'
   spec.add_dependency 'dry-struct'
+  spec.add_dependency 'colored2'
+  spec.add_dependency 'httparty'
 
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'bundler', '~> 1.15'

data/lib/arduino/library.rb

@@ -2,7 +2,13 @@ require 'open-uri'
 
 module Arduino
   module Library
-    DEFAULT_ARDUINO_LIBRARY_INDEX_URL = 'http://downloads.arduino.cc/libraries/library_index.json.gz'
+    DEFAULT_ARDUINO_LIBRARY_INDEX_URL  =
+      'http://downloads.arduino.cc/libraries/library_index.json.gz'
+    DEFAULT_ARDUINO_LIBRARY_PATH       =
+      ENV['ARDUINO_CUSTOM_LIBRARY_PATH'] || (ENV['HOME'] + '/Documents/Arduino/Libraries')
+    DEFAULT_ARDUINO_LIBRARY_INDEX_PATH =
+      ENV['ARDUINO_LIBRARY_INDEX_PATH'] ||
+        (ENV['HOME'] + '/Documents/Arduino/Libraries/index.json.gz')
   end
 end
 
@@ -12,6 +18,7 @@ require 'arduino/library/types'
 # noinspection RubyResolve
 require 'arduino/library/model'
 require 'arduino/library/database'
+require 'arduino/library/default_database'
 
 module Arduino
   module Library
@@ -21,7 +28,7 @@ module Arduino
     end
 
     def db_default
-      Database.default
+      DefaultDatabase.instance
     end
 
     #

data/lib/arduino/library/database.rb

@@ -1,33 +1,30 @@
-require 'open-uri'
-require 'zlib'
 require 'json'
 require 'forwardable'
-require 'arduino/library'
 require 'arduino/library/model'
+require 'arduino/library/utilities'
+require 'colored2'
 
 module Arduino
   module Library
-
     # This class represents a single entry into the library-index.json file,
     # in other words — a `library.properties` file.
     class Database
-      extend Forwardable
-      include Utilities
 
-      def_delegators :@db_list, *(Array.new.methods - Object.methods - [:search])
+      include Utilities
+      extend Forwardable
 
       class << self
         alias from new
-
-        def default
-          @default ||= new
-        end
       end
 
+      def_delegators :@db_list,
+                     *(Array.new.methods -
+                       Object.methods - [:search])
+
       attr_accessor :local_file,
                     :db_list
 
-      def initialize(file_or_url = Arduino::Library::DEFAULT_ARDUINO_LIBRARY_INDEX_URL)
+      def initialize(file_or_url)
         self.local_file = read_file_or_url(file_or_url)
         load_json
       end
@@ -48,25 +45,25 @@ module Arduino
         match_list
       end
 
-      private
+      protected
 
       def entry_matches?(entry, opts)
         matches = true
         opts.each_pair do |attr, check|
           value   = entry.send(attr)
           matches &= case check
-                      when String
-                        value == check
-                      when Regexp
-                        value =~ check
-                      when Array
-                        value = value.split(',') unless value.is_a?(Array)
-                        value.eql?(check) || value.include?(check) || value.first == '*'
-                      when Proc
-                        check.call(value)
-                      else
-                        raise InvalidArgument, "Class #{check.class.name} is unsupported for value checks"
-                    end
+                       when String
+                         value == check
+                       when Regexp
+                         value =~ check
+                       when Array
+                         value = value.split(',') unless value.is_a?(Array)
+                         value.eql?(check) || value.include?(check) || value.first == '*'
+                       when Proc
+                         check.call(value)
+                       else
+                         raise InvalidArgument, "Class #{check.class.name} is unsupported for value checks"
+                     end
           break unless matches
         end
       end
@@ -74,7 +71,7 @@ module Arduino
       private
 
       def load_json
-        hash = JSON.load(local_file.read)
+        hash         = JSON.load(local_file.read)
         self.db_list = hash['libraries'].map { |lib| Model.from_hash(lib) }
       end
     end

data/lib/arduino/library/default_database.rb

@@ -0,0 +1,60 @@
+require 'httparty'
+require 'open-uri'
+require_relative 'database'
+
+module Arduino
+  module Library
+    # This class represents a single entry into the library-index.json file,
+    # in other words — a `library.properties` file.
+
+    class DefaultDatabase < Database
+
+      class << self
+        attr_accessor :library_index_path,
+                      :library_path,
+                      :library_index_url
+
+        def instance
+          @default ||= self.send(:new)
+        end
+      end
+
+      self.library_index_path ||= DEFAULT_ARDUINO_LIBRARY_INDEX_PATH
+      self.library_index_url  ||= DEFAULT_ARDUINO_LIBRARY_INDEX_URL
+      self.library_path       ||= DEFAULT_ARDUINO_LIBRARY_PATH
+
+      attr_accessor :url, :path
+
+      def initialize
+        setup
+      end
+
+      def setup
+        self.url  = self.class.library_index_url
+        self.path = self.class.library_index_path
+
+        FileUtils.mkpath(File.dirname(path))
+
+        download_if_needed!
+
+        self.local_file = open_plain_or_gzipped(path)
+
+        load_json
+      end
+
+      def download_if_needed!
+        if File.exist?(path)
+          resp        = HTTParty.head(url)
+          remote_size = resp['content-length'].to_i
+          local_size  = File.size(path)
+          debug("remote: #{remote_size}, local #{local_size}")
+          return if remote_size == local_size
+          backup_previous_library(path)
+        end
+
+        download(url, path)
+      end
+
+    end
+  end
+end

data/lib/arduino/library/model.rb

@@ -39,7 +39,7 @@ module Arduino
         end
 
         def database
-          @database ||= Database.default
+          @database ||= DefaultDatabase.instance
         end
 
         def find(**opts)
@@ -56,7 +56,7 @@ module Arduino
         #
         #       Arduino::Library::Model.database = Database.from(file)
         #
-        # otherwise it defaults to the default database, +Database.default+.
+        # otherwise it defaults to the default database, +DefaultDatabase.instance+.
         #
         # @param [Hash] opts   — search parameters to the current database
         #

data/lib/arduino/library/utilities.rb

@@ -1,19 +1,52 @@
 require 'open-uri'
+require 'fileutils'
+require 'zlib'
 
 module Arduino
   module Library
-
     module Utilities
+
       def read_file_or_url(file_or_url)
         raise ArgumentError, 'Empty file_or_url provided' unless file_or_url
         temp_file = open(file_or_url)
+        open_plain_or_gzipped(file_or_url, temp_file)
+      end
+
+      def open_plain_or_gzipped(file_or_url, temp_file = nil)
         if file_or_url =~ /\.gz$/i
-          Zlib::GzipReader.new(temp_file)
+          Zlib::GzipReader.new(temp_file || File.open(file_or_url))
         else
           temp_file
         end
       end
-    end
 
+      def backup_previous_library(path)
+        debug "backup previous library: #{path.bold.green}"
+        new_name = nil
+        index    = 0
+
+        loop do
+          index += 1
+
+          new_name = "#{path}.#{index}"
+          break unless File.exist?(new_name)
+          debug "file #{new_name.bold.green} exists, next..."
+          raise 'Too many backup versions created, delete some first' if index > 20
+        end
+
+        debug "moving #{path.bold.green}", "to #{new_name.bold.blue}"
+        FileUtils.move(path, new_name)
+      end
+
+      def download(url, path)
+        open(path, 'wb') do |file|
+          file << open(url).read
+        end
+      end
+
+      def debug(*msgs)
+        puts "\n" + msgs.join("\n") if ENV['DEBUG']
+      end
+    end
   end
 end

data/lib/arduino/library/version.rb

@@ -1,6 +1,6 @@
 module Arduino
   module Library
-    VERSION = '0.3.1'
+    VERSION = '0.3.2'
     DESCRIPTION = <<-eof
       This gem encapsulates many concepts related to how Arduino Libraries are indexed, how their metadata is validated, or .properties file generated. It supports searching the Arduino library database for any terms. This gem is used by Arli — Arduino Installer CLI toolkit.
     eof

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino-library
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-22 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colored2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +172,7 @@ files:
 - bin/setup
 - lib/arduino/library.rb
 - lib/arduino/library/database.rb
+- lib/arduino/library/default_database.rb
 - lib/arduino/library/include.rb
 - lib/arduino/library/model.rb
 - lib/arduino/library/presenters/properties.rb