js-packer-rails 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: be8656037311c739980bfa750443d267011d9a95
-  data.tar.gz: 5e06acddc8209ff2125b9bad919130bfb359f536
+SHA256:
+  metadata.gz: 8595018f505d7070e8e1ddd771029b7aead0cf13c84720891a18c791c9aec204
+  data.tar.gz: bfabe95949ce07c5eba7039aad031351bb0c20ab255234ec795a29ab5d407191
 SHA512:
-  metadata.gz: 202d8dd58340b98a52d8741fdfd1ab51aa0f093c0ad912484183cc16e2c23a9569ac987fdcbc617cf08667717c4d0ee707f5b8ee86a34fec8c1feae2cb23075b
-  data.tar.gz: d49b9451207e7f3983b9b99133fe15a3749c8534104eefe2a55ed4821e55b57fd5b070f492e152dfd05f92ee7bac95319b7083ba02c180b2d21a8f5eb32db734
+  metadata.gz: 0b43b865c8f85c203382c1ee750d9cdd5776a7a7a2f779f503270bb67d07f41f44a1e876517e786bed0f6c8c60b4e0e2aea41472bdd2106084f1eac7737e5e6d
+  data.tar.gz: 0cfa22626ba9c9801ee1cc6b390ec0333d89445c1ce0364cbf42e94a927adc85030236b2d2c192d47837a6ae386d2a66c0afb7656a354e85bb89d7174cecf009

data/README.md

@@ -2,20 +2,30 @@
 The Packer allows you to easily include JavaScript bundle into your Rails project.
 JavaScript world offers a lot of great tools for bundling, uglifying, minifying... So, use it in your Rails app!
 It could be Webpack or Grunt or Gulp or Any New Awesome JS tool :)
-I believe the choice of the tools should depend on issues you want to solve, so use JS tool to prepare your source JS code.
+I believe the choice of the tools should depend on the issues you want to solve, so use JS tool to bundle your source JS code.
 
 The Packer:
-* don't care how do you bundle your JavaScript
-* don't use Rails assets pipeline
-* is only for Rails framework
-* require JavaScript manifest file
-* add 3 helper methods to your view:
+* doesn't care how do you bundle your JavaScript
+* doesn't use Rails assets pipeline
+* is dedicated only for Rails
+* requires JavaScript manifest file
+* adds 3 helper methods to your views:
 ```
 js_bundle_tag(*sources)
 js_bundle_hash(source)
 js_bundle_name(source)
 ```
 
+## Example
+
+How to use `js-packer-rails` gem in Rails app with:
+
+* Webpack
+* Babel
+* React
+
+[https://github.com/jcieslar/js_packer_rails_example](https://github.com/jcieslar/js_packer_rails_example)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -36,7 +46,7 @@ Or install it yourself as:
 
 ### JavaScript manifest file
 
-Example format of manifest:
+Generate manifest:
 
 ```json
 /* admin-bundle.json */
@@ -45,8 +55,8 @@ Example format of manifest:
 }
 ```
 
-So if your bundle name is: `bundle-example-name` then you have to generate manifest json:
-`bundle-example-name.json` which maps your bundle name into bundle name with hash:
+So if your JS bundle name is: `bundle-example-name` then you have to generate the following manifest:
+`bundle-example-name.json`
 
 ```json
 {
@@ -58,13 +68,15 @@ So if your bundle name is: `bundle-example-name` then you have to generate manif
 
 #### js_bundle_tag
 
-Just use `js_bundle_tag` in your view or layout by passing your bundle name:
+Use `js_bundle_tag` helper in your view/layout by passing your JS bundle name as an argument.
+It returns the script tag with the proper path to your JS bundle:
 
 ```
 <%= js_bundle_tag 'admin-bundle' %>
+# => <script src='bundle/javascripts/admin-bundle-f65a6b9fb09ba93b7ea6.js'></script>
 ```
 
-If you would like to include more then one bundle for view or layout just add more bundle names:
+If you would like to include more than one JS bundle, just add another argument:
 
 ```
 <%= js_bundle_tag 'admin-bundle', 'user-bundle' %>
@@ -72,31 +84,35 @@ If you would like to include more then one bundle for view or layout just add mo
 
 #### js_bundle_hash
 
-Helper `js_bundle_hash` would be useful to get your code version for your source maps:
+Use `js_bundle_hash` helper to get your JS bundle code version:
 
 ```
 <%= js_bundle_hash 'admin-bundle' %>
+# => f65a6b9fb09ba93b7ea6
 ```
 
 ### js_bundle_name
 
-Helper `js_bundle_name` return your bundle name with proper hash taken from manifest:
+Use `js_bundle_name` helper to get your JS bundle full name with a hash:
 
 ```
 <%= js_bundle_name 'admin-bundle' %>
+# => admin-bundle-f65a6b9fb09ba93b7ea6.js
 ```
 
 ### Bundle JavaScript
 
-Packer would be looking for JavaScript ` manifest` and `bundle` by default in directory `public/bundles/javascripts/`.
+Put your JSON manifest and JS bundle in `public/bundles/javascripts/` directory.
 
 ### Configuration
 
-You can change default directory of your manifest and bundle via YAML file: `config/packer.yml`
+You can change the default directory of your manifest and bundle via YAML file: `config/packer.yml`
 
-You can define paths by two params: `manifest_path` and `bundle_path`. Manifest and bundle should be in public directory. `manifest_path` should contain path starting from `public/` but `bundle_path` should skip `public/`
+You can define paths by two params: `manifest_path` and `bundle_path`.
+The manifest and bundle should be in the public directory.
+`manifest_path` should contain the path starting from `public/` while the `bundle_path` should skip `public/`
 
-Example:
+For example:
 
 ```yml
 default: &default

data/js-packer-rails.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jakub Cieslar"]
   spec.email         = ["cieslar.jakub@gmail.com"]
 
-  spec.summary       = %q{Pack your JS bundle into Rails app! Use whatever tool you want for your JS assets}
-  spec.description   = %q{Pack your JS bundle into Rails app! Use whatever tool you want for your JS assets}
+  spec.summary       = %q{Pack your JS bundle into Rails app! Use whatever tool you want for your JS assets. You do not need webpacker!}
+  spec.description   = %q{Pack your JS bundle into Rails app! Use whatever tool you want for your JS assets. You do not need webpacker!}
   spec.homepage      = "https://github.com/jcieslar/js-packer-rails"
   spec.license       = "MIT"
 
@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "railties", ">= 4.0.1"
+  spec.add_dependency "railties", ">= 4.0.13"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rails", ">= 4.0.1"
+  spec.add_development_dependency "rails", ">= 4.0.13"
 end

data/lib/js/packer/rails/version.rb

@@ -1,7 +1,7 @@
 module Js
   module Packer
     module Rails
-      VERSION = "0.0.1"
+      VERSION = "0.1.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-packer-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Jakub Cieslar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2018-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.0.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.0.13
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,16 +58,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.0.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.0.13
 description: Pack your JS bundle into Rails app! Use whatever tool you want for your
-  JS assets
+  JS assets. You do not need webpacker!
 email:
 - cieslar.jakub@gmail.com
 executables: []
@@ -104,9 +104,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Pack your JS bundle into Rails app! Use whatever tool you want for your JS
-  assets
+  assets. You do not need webpacker!
 test_files: []