webpacker_lite 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e6a7d776f0f2bb29a4cd64177a1ca8b447b358a
-  data.tar.gz: ade62ad9187e06fe8f3ed007641b5cbdf2b2ef28
+  metadata.gz: 7e2db317915bebedc04ee628df5ebb0d007cafd5
+  data.tar.gz: '047779354717394e059550b300f6b86f7e0653b4'
 SHA512:
-  metadata.gz: 90cb984e1db2305e0504a7a5ac0030bec26726b5ba7db0541a6b206444caf3e01ac06261452e2cb0d3cc9921cb9458ac0e45c37c17cd2ed1d0bf68cf14a057f0
-  data.tar.gz: 1d1f2c2b10e55f1e78c36fab16ff7969ac1ee24129b9bde2e224e2b650c0f1aee3bfe5e3e81274704263e06573d6ecb8a57c63e13f736c1bfee7a75ee4fea16c
+  metadata.gz: 8a1f1f0931790a5004fbde87baa04ded96dcf69270f19c17a6e7459c0343b91439efa2ec7afccbb7c8a0d39b92e2814c4454dff8d8d728d40feb0652c124d3db
+  data.tar.gz: 24e05588ada561572186806b1e18e4fdd889072b525b485b8f2a8d2d9013837224834b5b193ed69ad85c9528737f42d64c0ac0cb0e92e8b49407cdf608d9ea3f

data/.travis.yml

@@ -10,5 +10,4 @@ cache:
 install:
   - bundle install
 script:
-  - bundle exec rubocop
-  - bundle exec rake test
+  - bundle exec rake

data/CHANGELOG.md

@@ -6,6 +6,16 @@ Contributors: please follow the recommendations outlined at [keepachangelog.com]
 ## [Unreleased]
 *Please add entries here for your pull requests.*
 
+## [2.0.2] - 2017-05-26
+### Fixed
+* Fixed rake assets:clobber. [#11](https://github.com/shakacode/webpacker_lite/pull/11) by [dpuscher](https://github.com/dpuscher).
+
+## [2.0.1] - 2017-05-26
+
+### Changed
+* Added better error messages for missing files.
+* Added api to check if the manifest exists
+[#12](https://github.com/shakacode/webpacker_lite/pull/12) by [justin808](https://github.com/justin808).
 
 ## [2.0.0] - 2017-05-23
 All in [#9](https://github.com/shakacode/webpacker_lite/pull/9) by [justin808](https://github.com/justin808) with help from [conturbo](https://github.com/conturbo) on the tests.
@@ -20,6 +30,8 @@ All in [#9](https://github.com/shakacode/webpacker_lite/pull/9) by [justin808](h
 ## [1.0.0] - 2017-05-03
 Initial release
 
-[Unreleased]: https://github.com/shakacode/webpacker_lite/compare/2.0.0...master
+[Unreleased]: https://github.com/shakacode/webpacker_lite/compare/2.0.2...master
+[2.0.2]: https://github.com/shakacode/react_on_rails/compare/2.0.1...2.0.2
+[2.0.1]: https://github.com/shakacode/react_on_rails/compare/2.0.0...2.0.1
 [2.0.0]: https://github.com/shakacode/react_on_rails/compare/1.0.0...2.0.0
 [1.0.0]: https://github.com/shakacode/react_on_rails/compare/0.0.5...1.0.0

data/CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# Tips for Contributors
+
+## Summary
+
+For non-doc fixes:
+
+* Provide changelog entry in the [unreleased section of the CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/master/CHANGELOG.md#unreleased).
+* Ensure CI passes and that you added a test that passes with the fix and fails without the fix.
+* Optionally, squash all commits down to one with a nice commit message *ONLY* once final review is given. Make sure this single commit is rebased on top of master.
+* Please address all code review comments.
+* Ensure that docs are updated accordingly if a feature is added.
+
+## Commit Messages
+
+From [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/)
+
+#### The seven rules of a great git commit message
+> Keep in mind: This has all been said before.
+
+1. Separate subject from body with a blank line
+1. Limit the subject line to 50 characters
+1. Capitalize the subject line
+1. Do not end the subject line with a period
+1. Use the imperative mood in the subject line
+1. Wrap the body at 72 characters
+1. Use the body to explain what and why vs. how
+
+
+## To run:
+ 
+### Tests
+```
+rake test
+```
+
+### Linting
+
+```
+rake rubocop
+```
+
+or to autofix: 
+
+```
+bundle exec rubocop -a
+```
+
+### All ci
+
+```sh
+rake
+```
+
+# Configuring to test changes with your app
+
+Use the relative path syntax in your gemfile.
+
+```ruby
+gem "webpacker_lite", path: "../../../webpacker_lite"
+```
+
+# Advice for Project Maintainers and Contributors
+
+What do project maintainers do? What sort of work is involved? [sstephenson](https://github.com/sstephenson) wrote in the [turbolinks](https://github.com/turbolinks/turbolinks) repo:
+
+> [Why this is not still fully merged?](https://github.com/turbolinks/turbolinks/pull/124#issuecomment-239826060)
+
+# Releasing
+
+If the version to bump is `2.0.1`
+
+```
+gem bump --tag --push --version 2.0.1
+```
+
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    webpacker_lite (1.0.0)
+    webpacker_lite (2.0.1)
       activesupport (>= 4.2)
       multi_json (~> 1.2)
       railties (>= 4.2)

data/README.md

@@ -83,7 +83,7 @@ This example config shows how we use different output directories for the webpac
 default: &default
   manifest: manifest.json  
   # Used in your webpack configuration. Must be created in the
-  # webpack_public_output_dir folder
+  # webpack_public_output_dir folder.
   
 development:
   <<: *default
@@ -141,6 +141,7 @@ production:
 ## Other Helpers: Getting the asset path
 
 The `asset_pack_path` helper provides the path of any given asset that's been compiled by webpack.
+Note, the real file path is the subdirectory of the public.
 
 For example, if you want to create a `<link rel="prefetch">` or `<img />`
 for an asset used in your pack code you can reference them like this in your view,
@@ -148,6 +149,7 @@ for an asset used in your pack code you can reference them like this in your vie
 ```erb
 <img src="<%= asset_pack_path 'calendar.png' %>" />
 <% # => <img src="/webpack/calendar.png" /> %>
+<% # real file path "public/webpack/calendar.png" /> %>
 ```
 
 ## Webpack Helper

data/Rakefile

@@ -2,6 +2,16 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+# Executes a string or an array of strings in a shell in the given directory
+def sh_in_dir(dir, shell_commands)
+  shell_commands = [shell_commands] if shell_commands.is_a?(String)
+  shell_commands.each { |shell_command| sh %(cd #{dir} && #{shell_command.strip}) }
+end
+
+def gem_root
+  File.expand_path("../.", __FILE__)
+end
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
@@ -9,4 +19,9 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
-task default: :test
+desc "Run Rubocop as shell"
+task :rubocop do
+  sh_in_dir(gem_root, "bundle exec rubocop .")
+end
+
+task default: [:test, :rubocop]

data/lib/tasks/webpacker_lite/clobber.rake

@@ -12,6 +12,6 @@ end
 # Run clobber if the assets:clobber is run
 if Rake::Task.task_defined?("assets:clobber")
   Rake::Task["assets:clobber"].enhance do
-    Rake::Task["webpacker:clobber"].invoke
+    Rake::Task["webpacker_lite:clobber"].invoke
   end
 end

data/lib/webpacker_lite.rb

@@ -1,8 +1,8 @@
 module WebpackerLite
   def self.bootstrap
-    WebpackerLite::Env.load
-    WebpackerLite::Configuration.load
-    WebpackerLite::Manifest.load
+    WebpackerLite::Env.load_instance
+    WebpackerLite::Configuration.load_instance
+    WebpackerLite::Manifest.load_instance
   end
 
   def env

data/lib/webpacker_lite/configuration.rb

@@ -3,6 +3,8 @@ require "webpacker_lite/file_loader"
 require "webpacker_lite/env"
 
 class WebpackerLite::Configuration < WebpackerLite::FileLoader
+  RAILS_WEB_PUBLIC = "public"
+
   class << self
     def manifest_path
       Rails.root.join(webpack_public_output_dir,
@@ -10,8 +12,7 @@ class WebpackerLite::Configuration < WebpackerLite::FileLoader
     end
 
     def webpack_public_output_dir
-      Rails.root.join(
-        File.join("public", configuration.fetch(:webpack_public_output_dir, "webpack")))
+      Rails.root.join(RAILS_WEB_PUBLIC, configuration.fetch(:webpack_public_output_dir, "webpack"))
     end
 
     def base_path
@@ -37,8 +38,8 @@ class WebpackerLite::Configuration < WebpackerLite::FileLoader
     end
 
     def configuration
-      load if WebpackerLite::Env.development?
-      raise WebpackerLite::FileLoader::FileLoaderError.new("WebpackerLite::Configuration.load must be called first") unless instance
+      load_instance if WebpackerLite::Env.development?
+      raise WebpackerLite::FileLoader::FileLoaderError.new("WebpackerLite::Configuration.load_instance must be called first") unless instance
       instance.data
     end
 
@@ -48,7 +49,7 @@ class WebpackerLite::Configuration < WebpackerLite::FileLoader
   end
 
   private
-    def load
+    def load_data
       return super unless File.exist?(@path)
       HashWithIndifferentAccess.new(YAML.load(File.read(@path))[WebpackerLite::Env.current])
     end

data/lib/webpacker_lite/env.rb

@@ -25,7 +25,7 @@ class WebpackerLite::Env < WebpackerLite::FileLoader
   end
 
   private
-    def load
+    def load_data
       environments = File.exist?(@path) ? YAML.load(File.read(@path)).keys : [].freeze
       return ENV["NODE_ENV"] if environments.include?(ENV["NODE_ENV"])
       return Rails.env if environments.include?(Rails.env)

data/lib/webpacker_lite/file_loader.rb

@@ -7,22 +7,22 @@ class WebpackerLite::FileLoader
   attr_accessor :data
 
   class << self
-    def load(path = file_path)
+    def load_instance(path = file_path)
       self.instance = new(path)
     end
 
     def file_path
-      raise "Subclass of WebpackerLite::FileLoader should override this method"
+      raise FileLoaderError.new("Subclass of WebpackerLite::FileLoader should override this method")
     end
   end
 
   private
     def initialize(path)
       @path = path
-      @data = load
+      @data = load_data
     end
 
-    def load
+    def load_data
       {}.freeze
     end
 end

data/lib/webpacker_lite/manifest.rb

@@ -11,30 +11,61 @@ require "webpacker_lite/configuration"
 
 class WebpackerLite::Manifest < WebpackerLite::FileLoader
   class << self
-    def file_path
-      WebpackerLite::Configuration.manifest_path
+    # Helper method to determine if the manifest file exists.
+    def exist?
+      path_object = WebpackerLite::Configuration.manifest_path
+      path_object.exist?
     end
 
-    def lookup(name)
-      load if WebpackerLite::Env.development? || instance.data.empty?
-      raise WebpackerLite::FileLoader::FileLoaderError.new("WebpackerLite::Manifest.load must be called first") unless instance
-      instance.data[name.to_s] || missing_file_error(name)
+    def file_path
+      WebpackerLite::Configuration.manifest_path
     end
 
-    def missing_file_error(name)
+    def missing_file_from_manifest_error(bundle_name)
       msg = <<-MSG
-        WebpackerLite can't find #{name} in your manifest #{file_path}. Possible causes:
-          1. You are hot reloading
-          2. Webpack is not running
+        WebpackerLite can't find #{bundle_name} in your manifest #{file_path}. Possible causes:
+          1. You are hot reloading.
+          2. Webpack has not re-run to reflect updates.
           3. You have misconfigured WebpackerLite's config/webpacker_lite.yml file.
           4. Your Webpack configuration is not creating a manifest.
       MSG
       raise(WebpackerLite::FileLoader::NotFoundError.new(msg))
     end
+
+    # Same as lookup, but raises an error.
+    def lookup!(name)
+      lookup(name) || missing_file_from_manifest_error(name)
+    end
+
+    # Find the real file name from the manifest key.
+    def lookup(name)
+      instance.confirm_manifest_exists
+
+      load_instance if WebpackerLite::Env.development? || instance.data.empty?
+      raise WebpackerLite::FileLoader::FileLoaderError.new("WebpackerLite::Manifest.load must be called first") unless instance
+      instance.data[name.to_s]
+    end
+  end
+
+  def confirm_manifest_exists
+    raise missing_manifest_file_error(@path) unless File.exist?(@path)
   end
 
   private
-    def load
+
+    def missing_manifest_file_error(path_object)
+      msg = <<-MSG
+
+        WebpackerLite can't find the manifest file: #{path_object}
+        Possible causes:
+          1. You have not invoked webpack.
+          2. You have misconfigured WebpackerLite's config/webpacker_lite.yml file.
+          3. Your Webpack configuration is not creating a manifest.
+    MSG
+      raise(WebpackerLite::FileLoader::NotFoundError.new(msg))
+    end
+
+    def load_data
       return super unless File.exist?(@path)
       JSON.parse(File.read(@path))
     end

data/lib/webpacker_lite/version.rb

@@ -1,3 +1,3 @@
 module WebpackerLite
-  VERSION = "2.0.0".freeze
+  VERSION = "2.0.2".freeze
 end

data/test/manifest_test.rb

@@ -11,14 +11,14 @@ class ManifestTest < Minitest::Test
     asset_file = "calendar.js"
     msg = <<-MSG
         WebpackerLite can't find #{asset_file} in your manifest #{manifest_path}. Possible causes:
-          1. You are hot reloading
-          2. Webpack is not running
+          1. You are hot reloading.
+          2. Webpack has not re-run to reflect updates.
           3. You have misconfigured WebpackerLite's config/webpacker_lite.yml file.
           4. Your Webpack configuration is not creating a manifest.
     MSG
 
     error = assert_raises WebpackerLite::FileLoader::NotFoundError do
-      WebpackerLite::Manifest.lookup(asset_file)
+      WebpackerLite::Manifest.lookup!(asset_file)
     end
 
     assert_equal error.message, msg
@@ -26,6 +26,6 @@ class ManifestTest < Minitest::Test
 
   def test_lookup_success
     asset_file = "bootstrap.js"
-    assert_equal WebpackerLite::Manifest.lookup(asset_file), "bootstrap-300631c4f0e0f9c865bc.js"
+    assert_equal WebpackerLite::Manifest.lookup!(asset_file), "bootstrap-300631c4f0e0f9c865bc.js"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpacker_lite
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - David Heinemeier Hansson, Justin Gordon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,6 +76,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE