webpack_manifest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb2ef747217989c47a8781f7e049328a6794f4e069cfe014776dfa4e8670c85e
+  data.tar.gz: d465f2d48d57638ab060f146a19f5eee0b41e5f2b8f43626522d054f62c4bdb2
+SHA512:
+  metadata.gz: 2b5a3fc1c9dca56074dc26efd3a8127a3a81775e45de0aa3ede5de04818281c35e9cb4e9425d0b7f398355c99eaf6f0ac0dce587f80aaebf8908ea707a800aaa
+  data.tar.gz: f224eaa75f9f44118f7f13e9b8f1f658a02b9462bf495bdd92a36d94de1617fe03f1049f09fee5ef32a51562ef4f31f446d2d41660283d85b58810129da8e263

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 / 2018-10-17
+
+Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nobuhiro Nikushi
+
+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,76 @@
+# WebpackManifest
+
+WebpackManifest is a gem that integrate ruby with npm's [webpack-manifest-plugin](https://www.npmjs.com/package/webpack-manifest-plugin).
+
+## Features
+
+* Rails view helpers to access assets which are built by webpack according a manifest file.
+* Multiple manifest files support
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webpack_manifest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webpack_manifest
+
+## Usage
+
+### Rails view helpers
+
+* `#asset_bundle_path`
+* `#javascript_bundle_tag`
+* `#stylesheet_bundle_tag`
+* `#image_bundle_tag`
+
+### Configuration
+
+```rb
+# In config/initializers/webpack_manifest.rb
+
+cache = if Rails.env.development?
+          false
+        else
+          true
+        end
+manifest = WebpackManifest::Manifest.new(
+  Rails.root.join('public', 'assets', 'manifest.json'),
+  cache: cache,
+)
+```
+
+
+### Multiple manifest support
+
+TBD
+
+## Roadmap
+
+* [x] Implement manifest class
+* [x] Implement Rails view helpers
+* [ ] Configuration generator for Rails initializers
+* [ ] Multiple manifest files support
+* [ ] Write document more
+
+## 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/[USERNAME]/webpack_manifest.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/webpack_manifest.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WebpackManifest
+  require 'webpack_manifest/manifest'
+  require 'webpack_manifest/rails'
+  require "webpack_manifest/version"
+end

data/lib/webpack_manifest/manifest.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module WebpackManifest
+  class Manifest
+    class MissingEntryError < StandardError; end
+
+    def initialize(path_or_hash, cache: false)
+      @path_or_hash = path_or_hash
+      @cache_manifest = cache
+    end
+
+    def lookup!(name)
+      find(name) || handle_missing_entry(name)
+    end
+
+    def find(name)
+      data[name.to_s]
+    end
+
+    def assets
+      data.values
+    end
+
+    private
+
+    def data
+      if @cache_manifest
+        @data ||= load_data
+      else
+        load_data
+      end
+    end
+
+    def load_data
+      return @path_or_hash if @path_or_hash.is_a? Hash
+      path = @path_or_hash
+      File.exist?(path) ? JSON.parse(File.read(path)) : {}
+    end
+
+    def handle_missing_entry(name)
+      raise MissingEntryError, <<~MSG
+        Can not find #{name} in #{@path_or_hash}.
+        Your manifest contains:
+        #{JSON.pretty_generate(@data)}
+      MSG
+    end
+  end
+end

data/lib/webpack_manifest/rails.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WebpackManifest
+  module Rails
+    require 'webpack_manifest/rails/helper'
+
+    class << self
+      # TODO: multiple manifest files support
+      attr_accessor :manifest
+    end
+  end
+end
+
+require 'active_support/lazy_load_hooks'
+
+ActiveSupport.on_load :action_view do
+  ::ActionView::Base.send :include, WebpackManifest::Rails::Helper
+end

data/lib/webpack_manifest/rails/helper.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module WebpackManifest::Rails::Helper
+  # Example:
+  #
+  #   <%= asset_bundle_path 'calendar.css' %> # => "/assets/web/pack/calendar-1016838bab065ae1e122.css"
+  #   <%= asset_bundle_path 'icon/favicon.ico' %> # => "/assets/web/pack/icon/favicon-1016838bab065ae1e122.ico"
+  def asset_bundle_path(name, **options)
+    asset_path(
+      WebpackManifest::Rails.manifest.lookup!(name.to_s),
+      **options,
+    )
+  end
+
+  # Example:
+  #
+  #   <%= javascript_bundle_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <script src="/assets/web/pack/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
+  #
+  #   <%= javascript_bundle_tag 'orders/app'  %> # =>
+  #   <script src="/assets/web/pack/orders/app-1016838bab065ae1e314.js"></script>
+  def javascript_bundle_tag(*names, **options)
+    javascript_include_tag(*sources_from_manifest(names, 'js'), **options)
+  end
+
+  # Examples:
+  #
+  #   <%= stylesheet_bundle_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <link rel="stylesheet" media="screen"
+  #    href="/assets/web/pack/calendar-1016838bab065ae1e122.css" data-turbolinks-track="reload" />
+  #
+  #   <%= stylesheet_bundle_tag 'orders/style' %> # =>
+  #   <link rel="stylesheet" media="screen"
+  #    href="/assets/web/pack/orders/style-1016838bab065ae1e122.css" />
+  def stylesheet_bundle_tag(*names, **options)
+    stylesheet_link_tag(*sources_from_manifest(names, 'css'), **options)
+  end
+
+  # Examples:
+  #
+  #   <%= image_bundle_tag 'icon.png'
+  #   <img src="/assets/pack/icon-1016838bab065ae1e314.png" />
+  #
+  #   <%= image_bundle_tag "icon.png", size: "16x10", alt: "Edit Entry"
+  #   <img src="/assets/pack/icon-1016838bab065ae1e314.png" width="16" height="10" alt="Edit Entry" />
+  def image_bundle_tag(name, **options)
+    image_tag(
+      WebpackManifest::Rails.manifest.lookup!(name.to_s),
+      **options,
+    )
+  end
+
+  private
+
+  def sources_from_manifest(names, ext)
+    names.map { |name| WebpackManifest::Rails.manifest.lookup!(name + '.' + ext) }
+  end
+end

data/lib/webpack_manifest/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WebpackManifest
+  VERSION = "0.1.0"
+end

data/webpack_manifest.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "webpack_manifest/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "webpack_manifest"
+  spec.version       = WebpackManifest::VERSION
+  spec.authors       = ["Nobuhiro Nikushi"]
+  spec.email         = ["deneb.ge@gmail.com"]
+
+  spec.summary       = "A gem to integrate ruby with npm's webpack-manifest-plugin package"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/nikushi/webpack_manifest"
+  spec.license       = "MIT"
+  spec.files         = Dir['lib/**/*.rb'] + %w[
+    CHANGELOG.md
+    LICENSE.txt
+    README.md
+    Rakefile
+    webpack_manifest.gemspec
+  ]
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency 'actionview'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: webpack_manifest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nobuhiro Nikushi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem to integrate ruby with npm's webpack-manifest-plugin package
+email:
+- deneb.ge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webpack_manifest.rb
+- lib/webpack_manifest/manifest.rb
+- lib/webpack_manifest/rails.rb
+- lib/webpack_manifest/rails/helper.rb
+- lib/webpack_manifest/version.rb
+- webpack_manifest.gemspec
+homepage: https://github.com/nikushi/webpack_manifest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A gem to integrate ruby with npm's webpack-manifest-plugin package
+test_files: []