motion 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63f815dc74ec8255bd6b7b07fae885691253e7903397ec2b6f1e79cc675c7261
-  data.tar.gz: 758239f08e068912a6e213773c0cc3d86338ecec6f738650f19f1a9d83656995
+  metadata.gz: c1b1922ab9d0ef3ead51f333bf255e48f1f470a475ccc2463726e7d805d26344
+  data.tar.gz: 57204e95779dfffb7413bb5080da1fb97f8d0bd519a6ae5f07cce80e4bad58f7
 SHA512:
-  metadata.gz: dfc01de3b79448af437bc4a0386ab2a9800e75ecb7d0231dc565d2bb6e3a21699fc9d7e6b58932824f0dc9ced1c59ae4426e40b9486198f7d082dcf0a5d7ee68
-  data.tar.gz: 86223b046b0957a69d4d7301a0a6c5d85a51cdacd4b088eaa4b65fdd57643043bde5970aaa5de55fd093257b66f5cd2e06c320b891c02f7ec255ba1b3d7a824b
+  metadata.gz: 3240417ce4c5928aa52c17fb1eb89aa641983d1c119d0ad38b7ec05e60c29172ac95fac9b1ab5cba6ef35ea94b7df819b2b917213cfb193dbb749484b485a33a
+  data.tar.gz: b7c973c8a93f0c9fac94fffa21a6b597635e064c4363b55d6718704bfdc5936125956e9116ebafb2936d5c555c95c34dff7e474a873605d49b36b7e0bebefeac

data/lib/generators/motion/templates/motion.rb

@@ -5,13 +5,16 @@ Motion.configure do |config|
   # version of your application. By default, the commit hash from git is used,
   # but depending on your deployment, this may not be available in production.
   #
-  # If you are sure that git is available in your production enviorment, you can
-  # uncomment this line:
+  # Motion automatically calculates your revision by hashing the contents of
+  # files in `revision_paths` The defaults revision paths are:
+  # rails paths, bin, and Gemfile.lock.
   #
-  #     config.revision = `git rev-parse HEAD`.chomp
+  # To change or add to your revision paths, uncomment this line:
   #
-  # If git is not available in your production enviorment, you must identify
-  # your application version some other way:
+  #     config.revision_paths += w(additional_path another_path)
+  #
+  # If you prefer to use git or an environmental variable for the revision
+  # in production, define the revision directly below.
   #
   #     config.revision =
   #       ENV.fetch("MY_DEPLOYMENT_NUMBER") { `git rev-parse HEAD`.chomp }

data/lib/motion.rb

@@ -14,6 +14,7 @@ module Motion
   autoload :LogHelper, "motion/log_helper"
   autoload :MarkupTransformer, "motion/markup_transformer"
   autoload :Railtie, "motion/railtie"
+  autoload :RevisionCalculator, "motion/revision_calculator"
   autoload :Serializer, "motion/serializer"
   autoload :TestHelpers, "motion/test_helpers"
 

data/lib/motion/action_cable_extentions/declarative_notifications.rb

@@ -62,7 +62,7 @@ module Motion
       #
       # See `ActionCable::Channel::PeriodicTimers` for details.
       def _setup_declarative_notifcation_timer(notification, interval)
-        return if connection.is_a?(ActionCable::Channel::ConnectionStub) ||
+        return if _stubbed_connection? ||
           @_declarative_notifications_timers.include?(notification)
 
         callback = proc do
@@ -77,6 +77,11 @@ module Motion
         active_periodic_timers << timer
       end
 
+      def _stubbed_connection?
+        defined?(ActionCable::Channel::ConnectionStub) &&
+          connection.is_a?(ActionCable::Channel::ConnectionStub)
+      end
+
       def _shutdown_declarative_notifcation_timer(notification, *)
         timer = @_declarative_notifications_timers.delete(notification)
         return unless timer

data/lib/motion/configuration.rb

@@ -59,16 +59,17 @@ module Motion
       Rails.application.key_generator.generate_key("motion:secret")
     end
 
+    option :revision_paths do
+      require "rails"
+
+      Rails.application.config.paths.dup.tap do |paths|
+        paths.add "bin", glob: "*"
+        paths.add "Gemfile.lock"
+      end
+    end
+
     option :revision do
-      warn <<~MSG # TODO: Better message (Focus on "How do I fix this?")
-        Motion is automatically inferring the application's revision from git.
-        Depending on your deployment, this may not work for you in production.
-        If it does, add "config.revision = `git rev-parse HEAD`.chomp" to your
-        Motion initializer. If it does not, do something else (probably read an
-        env var or something).
-      MSG
-
-      `git rev-parse HEAD`.chomp
+      RevisionCalculator.new(revision_paths: revision_paths).perform
     end
 
     option :renderer_for_connection_proc do

data/lib/motion/errors.rb

@@ -148,4 +148,14 @@ module Motion
       super("The revision cannot contain a NULL byte")
     end
   end
+
+  class BadRevisionPathsError < Error
+    def initialize
+      super(<<~MSG)
+        Revision paths must be a Rails::Paths::Root object or an object
+        that responds to `all_paths.flat_map(&:existent)` and returns an
+        Array of strings representing full paths.
+      MSG
+    end
+  end
 end

data/lib/motion/revision_calculator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "digest"
+require "motion"
+
+module Motion
+  class RevisionCalculator
+    attr_reader :revision_paths
+
+    def initialize(revision_paths:)
+      @revision_paths = revision_paths
+    end
+
+    def perform
+      derive_file_hash
+    end
+
+    private
+
+    def derive_file_hash
+      digest = Digest::MD5.new
+
+      files.each do |file|
+        digest << file # include filename as well as contents
+        digest << File.read(file)
+      end
+
+      digest.hexdigest
+    end
+
+    def existent_paths
+      @existent_paths ||=
+        begin
+          revision_paths.all_paths.flat_map(&:existent)
+        rescue
+          raise BadRevisionPathsError
+        end
+    end
+
+    def existent_files(path)
+      Dir["#{path}/**/*", path].reject { |f| File.directory?(f) }.uniq
+    end
+
+    def files
+      @files ||= existent_paths.flat_map { |path| existent_files(path) }.sort
+    end
+  end
+end

data/lib/motion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Motion
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Alec Larsen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -74,6 +74,7 @@ files:
 - lib/motion/log_helper.rb
 - lib/motion/markup_transformer.rb
 - lib/motion/railtie.rb
+- lib/motion/revision_calculator.rb
 - lib/motion/serializer.rb
 - lib/motion/test_helpers.rb
 - lib/motion/version.rb
@@ -85,7 +86,7 @@ metadata:
   source_code_uri: https://github.com/unabridged/motion
 post_install_message: |
   Friendly reminder: When updating the motion gem, don't forget to update the
-  NPM package as well (`bin/yarn add '@unabridged/motion@0.2.1'`).
+  NPM package as well (`bin/yarn add '@unabridged/motion@0.2.2'`).
 rdoc_options: []
 require_paths:
 - lib