js-packer-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be8656037311c739980bfa750443d267011d9a95
+  data.tar.gz: 5e06acddc8209ff2125b9bad919130bfb359f536
+SHA512:
+  metadata.gz: 202d8dd58340b98a52d8741fdfd1ab51aa0f093c0ad912484183cc16e2c23a9569ac987fdcbc617cf08667717c4d0ee707f5b8ee86a34fec8c1feae2cb23075b
+  data.tar.gz: d49b9451207e7f3983b9b99133fe15a3749c8534104eefe2a55ed4821e55b57fd5b070f492e152dfd05f92ee7bac95319b7083ba02c180b2d21a8f5eb32db734

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in js-packer-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: .
+  specs:
+    js-packer-rails (0.0.1)
+      railties (>= 4.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.0)
+      actionpack (= 5.2.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.0)
+      activesupport (= 5.2.0)
+      globalid (>= 0.3.6)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activestorage (5.2.0)
+      actionpack (= 5.2.0)
+      activerecord (= 5.2.0)
+      marcel (~> 0.3.1)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    erubi (1.7.1)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nio4r (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.4)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.0)
+      actioncable (= 5.2.0)
+      actionmailer (= 5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      activemodel (= 5.2.0)
+      activerecord (= 5.2.0)
+      activestorage (= 5.2.0)
+      activesupport (= 5.2.0)
+      bundler (>= 1.3.0)
+      railties (= 5.2.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  js-packer-rails!
+  rails (>= 4.0.1)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jakub Cieslar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,151 @@
+# Js::Packer::Rails
+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.
+
+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:
+```
+js_bundle_tag(*sources)
+js_bundle_hash(source)
+js_bundle_name(source)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'js-packer-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install js-packer-rails
+
+## Usage
+
+### JavaScript manifest file
+
+Example format of manifest:
+
+```json
+/* admin-bundle.json */
+{
+  "admin-bundle.js": "admin-bundle-f65a6b9fb09ba93b7ea6.js"
+}
+```
+
+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:
+
+```json
+{
+  "bundle-example-name.js": "bundle-example-name-[bundle hash].js"
+}
+```
+
+### Rails view
+
+#### js_bundle_tag
+
+Just use `js_bundle_tag` in your view or layout by passing your bundle name:
+
+```
+<%= js_bundle_tag 'admin-bundle' %>
+```
+
+If you would like to include more then one bundle for view or layout just add more bundle names:
+
+```
+<%= js_bundle_tag 'admin-bundle', 'user-bundle' %>
+```
+
+#### js_bundle_hash
+
+Helper `js_bundle_hash` would be useful to get your code version for your source maps:
+
+```
+<%= js_bundle_hash 'admin-bundle' %>
+```
+
+### js_bundle_name
+
+Helper `js_bundle_name` return your bundle name with proper hash taken from manifest:
+
+```
+<%= js_bundle_name 'admin-bundle' %>
+```
+
+### Bundle JavaScript
+
+Packer would be looking for JavaScript ` manifest` and `bundle` by default in directory `public/bundles/javascripts/`.
+
+### Configuration
+
+You can change 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/`
+
+Example:
+
+```yml
+default: &default
+  manifest_path: public/js/bundles
+  bundle_path: js/bundles
+
+development:
+  <<: *default
+test:
+  <<: *default
+production:
+  <<: *default
+```
+
+### Example Webpack setup
+
+Use webpack plugin `webpack-manifest-plugin`
+
+```js
+const path = require('path')
+const ManifestPlugin = require('webpack-manifest-plugin')
+
+module.exports = {
+  entry: {
+    'admin-bundle': path.resolve(__dirname, 'src', 'index.js'),
+  },
+  output: {
+    filename: 'admin-bundle-[hash].js',
+    sourceMapFilename: 'admin-bundle-[hash].js.map',
+    path: path.resolve('../../public/bundles/javascripts/'),
+  },
+  plugins: [
+    new ManifestPlugin({
+      fileName: 'admin-bundle.json',
+    }),
+  ],
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jcieslar/js-packer-rails.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/js-packer-rails.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "js/packer/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "js-packer-rails"
+  spec.version       = Js::Packer::Rails::VERSION
+  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.homepage      = "https://github.com/jcieslar/js-packer-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 4.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rails", ">= 4.0.1"
+end

data/lib/js-packer-rails.rb

@@ -0,0 +1,2 @@
+require 'js/packer/rails/version'
+require 'js/packer/rails/railtie' if defined?(Rails)

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

@@ -0,0 +1,14 @@
+require 'js/packer/rails/view_helpers'
+require 'rails'
+
+module Js
+  module Packer
+    module Rails
+      class Railtie < ::Rails::Railtie
+        initializer "js_packer_rails.view_helpers" do
+          ActionView::Base.send :include, ViewHelpers
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,53 @@
+require 'rails'
+
+module Js
+  module Packer
+    module Rails
+      module ViewHelpers
+        def js_bundle_tag(*sources)
+          sources.uniq.map do |source|
+            bundle_name = js_bundle_name(source)
+            content_tag :script, '', src: "#{bundle_path(bundle_name)}"
+          end.join("\n").html_safe
+        end
+
+        def js_bundle_hash(source)
+          bundle_name = js_bundle_name(source)
+          bundle_name.gsub("#{source}-", '').gsub('.js', '')
+        end
+
+        def js_bundle_name(source)
+          manifest_file = File.read(manifest_path(source))
+          manifest = JSON.parse(manifest_file)
+          manifest[source + '.js']
+        end
+
+        private
+
+        def manifest_path(source)
+          "#{::Rails.root}/#{config_manifest_path}/#{source}.json"
+        end
+
+        def bundle_path(bundle_name)
+          "/#{config_bundle_path}/#{bundle_name}"
+        end
+
+        def config?
+          File.exist?("#{::Rails.root}/config/packer.yml")
+        end
+
+        def config
+          YAML.load_file("#{::Rails.root}/config/packer.yml")[::Rails.env]
+        end
+
+        def config_manifest_path
+          config? ? config['manifest_path'] : 'public/bundles/javascripts'
+        end
+
+        def config_bundle_path
+          config? ? config['bundle_path'] : 'bundles/javascripts'
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: js-packer-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jakub Cieslar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+description: Pack your JS bundle into Rails app! Use whatever tool you want for your
+  JS assets
+email:
+- cieslar.jakub@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- js-packer-rails.gemspec
+- lib/js-packer-rails.rb
+- lib/js/packer/rails/railtie.rb
+- lib/js/packer/rails/version.rb
+- lib/js/packer/rails/view_helpers.rb
+homepage: https://github.com/jcieslar/js-packer-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Pack your JS bundle into Rails app! Use whatever tool you want for your JS
+  assets
+test_files: []