fancybox2 0.0.5 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2ebfac4305bcbb63e0c539f2bcf665b3d76103dda23ce778af75b9b4dcab683
-  data.tar.gz: c23595776e88b5d3cb58853dca0e394485c0f556cbfded59bc528af3c8d81154
+  metadata.gz: 3656436f12dfd2d4129e12b7db0ffd45a116698030802589a729ee82bc829948
+  data.tar.gz: 75f33ab435919e63a9696ef84a731084060bf3cc654a0a80d427b6c96c38f89a
 SHA512:
-  metadata.gz: 4333bdd2ed269d3f35066558984024baed4b71f776c5c1b3c8813ee99af8cafeb397203c48fe166d0d3890ca5e90a339ed2e2357a491550aad55815b560f42cc
-  data.tar.gz: 2df663ca74c34c912d159c2c0b127883d94e3754a236e6b01a3fd0bb2321dfc8ec52365e419fa21598fba476347ad3b1f4d0d237eee34dff8d37c3f369660c9c
+  metadata.gz: fdbd2c3d7e2e69882a53d830c49bf7ee8341c5091bbd43ed55fda77776da36326c16c0c5093a5ed62ef8632357fa0c14e8cc951846352ca9f001fec72b88bad8
+  data.tar.gz: 01716640347e04c37b72cdf7fc9b8055c2685beb59381f7869f6b08fc86614eb8a747dfd1611e37e1aa6f6f61424f22da5e1d1363a63d255671d73860132078e

data/lib/fancybox2/migrations/base.rb

@@ -0,0 +1,24 @@
+module Fancybox2
+  module Migrations
+    class Base
+
+      class << self
+        def self.descendants
+          ObjectSpace.each_object(Class).select { |klass| klass < self }
+        end
+      end
+
+      attr_reader :name, :version
+
+      def initialize(name)
+        @name = name
+
+        @version = Runner.extract_and_validate_version_from name
+      end
+
+      def call(up_or_down = :up)
+        send up_or_down
+      end
+    end
+  end
+end

data/lib/fancybox2/migrations/exceptions.rb

@@ -0,0 +1,13 @@
+module Fancybox2
+  module Migrations
+    module Exceptions
+
+      class FileNameError < StandardError
+        def initialize(message = nil)
+          message = message || 'One of the provided migrations file has an invalid name'
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/fancybox2/migrations/runner.rb

@@ -0,0 +1,113 @@
+module Fancybox2
+  module Migrations
+    class Runner
+      include Exceptions
+
+      VERSION_REGEXP = /^(\d+)/.freeze
+
+      class << self
+
+        def extract_and_validate_version_from(migration_name)
+          version = migration_name.to_s.scan(VERSION_REGEXP).flatten.first
+          unless version
+            raise ArgumentError, 'migration name must start with a positive integer number e.g: 1_do_something.rb'
+          end
+
+          version.to_i
+        end
+
+        def auto(migrations_folder, last_migrated_file_path: nil, logger: nil)
+          # Try to read file content, rescue with nil
+          content = File.read(last_migrated_file_path) rescue nil
+          # Extract last run migration version
+          last_run_migration_version = content.to_i
+
+          runner = new(migrations_folder, logger: logger)
+          last_migrated = runner.run last_migrated: last_run_migration_version
+          # Update migration status file
+          if last_migrated
+            f = File.open last_migrated_file_path, 'w'
+            f.write last_migrated.version
+            f.close
+          end
+        end
+      end
+
+      attr_reader :files_path, :current_version, :migrations, :logger
+
+      def initialize(files_path, logger: nil)
+        @files_path = files_path
+        @logger = logger || ::Logger.new(STDOUT)
+
+        load_migrations
+      end
+
+      # @param from a valid migration name or version
+      # @param to a valid migration name or version
+      # @return last run migration
+      def run(from: nil, to: nil, last_migrated: nil)
+        if from && last_migrated
+          logger.warn "#{self.class}#run - Both 'from' and 'last_migrated' params given. Only 'last_migrated' considered"
+        end
+        # Extract and validate versions
+        from = self.class.extract_and_validate_version_from(from || last_migrated || 0)
+        # This works independently from the direction if migrations' folder contains only migrations of last installed version
+        to = self.class.extract_and_validate_version_from (to || @migrations.last.version)
+        # Select migrations to run
+        to_run, direction = migrations_to_run from, to
+        # If last_migrated param has been provided, remove some migration from the list depending on direction
+        if last_migrated && to_run.any?
+          if direction == :up && last_migrated == to_run.first.version
+            to_run.shift
+          elsif direction == :down
+            # We surely have at least 2 migrations in the array, otherwise the direction would've been :up
+            to_run.pop
+          end
+        end
+        to_run.each do |migration|
+          logger.info "Running migration #{migration.name}"
+          migration.send direction
+        end
+
+        to_run.last
+      end
+
+      def load_migrations
+        # Load files from files_path and create classes
+        @migrations = Dir[File.join(File.expand_path(files_path), '**', '*.rb')].map do |file_path|
+          migration_name = File.basename(file_path)
+          klass = Class.new(Base)
+          klass.class_eval(File.read(file_path), file_path)
+          klass.freeze
+          klass.new migration_name
+        end.sort_by { |migration| migration.version }
+      end
+
+      # Select migrations to run depending given a starting and an ending one
+      def migrations_to_run(from, to)
+        selected = []
+        direction = from <= to ? :up : :down
+        @migrations.each do |m|
+          # downgrading - Break if we already arrived to "from" migration (e.g from=4, to=2 => 1, >2<, 3, *4*, 5)
+          break if (from > to) && (m.version > from)
+          # upgrading - Break if we already arrived to "to" migration (e.g from=2, to=4 => 1, *2*, 3, >4<, 5)
+          break if (from < to) && (m.version > to)
+          # downgrading - Skip until we arrive to "to" migration (e.g from=4, to=2 => 1, >2<, 3, *4*, 5)
+          next if (from > to) && (m.version < to)
+          # upgrading - Skip until we arrive to "from" migration (e.g from=2, to=4 => 1, *2*, 3, >4<, 5)
+          next if (from <= to) && (m.version < from)
+          # Break if we're already out of range
+          break if (m.version > from && m.version > to)
+
+          if m.version <= from
+            selected.prepend m
+          else
+            selected.append m
+          end
+        end
+
+        [selected, direction]
+      end
+    end
+  end
+end

data/lib/fancybox2/module/base.rb

@@ -87,14 +87,10 @@ module Fancybox2
           @on_configs = block
           return
         end
-        begin
-          # Try to parse
-          cfg = JSON.parse packet.payload
-          if cfg && cfg['configs']
-            self.configs.merge! cfg['configs']
-          end
-        rescue JSON::ParserError
-          logger.debug 'on_configs: failed parsing packet as JSON'
+
+        cfg = packet.payload
+        if cfg && cfg.is_a?(Hash) && cfg['configs']
+          self.configs.merge! cfg['configs']
         end
 
         @on_configs.call(packet) if @on_configs

data/lib/fancybox2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fancybox2
-  VERSION = '0.0.5'
+  VERSION = '0.0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fancybox2
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.10
 platform: ruby
 authors:
 - Alessandro Verlato
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -66,6 +66,9 @@ files:
 - lib/fancybox2/logger/json_formatter.rb
 - lib/fancybox2/logger/mqtt_log_device.rb
 - lib/fancybox2/logger/multi.rb
+- lib/fancybox2/migrations/base.rb
+- lib/fancybox2/migrations/exceptions.rb
+- lib/fancybox2/migrations/runner.rb
 - lib/fancybox2/module/base.rb
 - lib/fancybox2/module/config.rb
 - lib/fancybox2/module/exceptions.rb