simpacker 0.3.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 444b754848602fa63f5531bc7beb0d50714a686ff63bd58192373bac6c66c40f
-  data.tar.gz: 1fca8576ce3d3d982ab9b23ca043757e98d3bc5af35522cff0f4e2615323b4e6
+  metadata.gz: '093b3b132f0eb539351f2e441b6542063c34966c57be970863f131a18881da08'
+  data.tar.gz: dd4bcb552fb6679e622649ea990d07a56651d9b854e8c85f7257bdf58d919a7b
 SHA512:
-  metadata.gz: 84a3dfc8d926d60e407e0b6c34527e4ba153165f6143f2a5d406cf02d276e69bb19c2b9112c01e89b5c200ce2676d2bc0f9349d203f805c8804cad6599fb35b2
-  data.tar.gz: 6fa86aa1d886cdc732a94b9c90ca3961d427472ef98a30eb67931ef0fd78d5914dd591a3f0ac9fe0ba32a8049fd678b4d7e603e693860ba23870b5995acf9f75
+  metadata.gz: 05ce8120a614e150d79f849f993c407d68d167e3fd501a219298f2d3c53478a07504f9a6b9edc8f04c09b121482aba36ef7886c03b44e12b54fde41535b46d9b
+  data.tar.gz: 2fddc269856cc17c2fea0e4b3d95fed81d74e035feefb155682bd236d61866060763f9762c8f949695c4d1f030b0d8b7056bfd5638c1bb1f90ea93d4ea1a33f2

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
+/node_modules/

data/.prettierignore

@@ -0,0 +1 @@
+**/public/packs/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## v1.2.0
+
+- Add image_pack_url, favicon_pack_tag to helpers #67
+
+## v1.1.2
+
+- Set output option to manifest.json in webpack.config.js
+
+## v1.1.1
+
+- Fix deprecation warnings for Ruby 2.7 keyword arguments
+
+## v1.1.0
+
+- Allow `Manifest#lookup` to access nested fields.
+- Drop TypeScript from default installer.
+- Improve error handling.
+
+## v1.0.0
+
+- Initial release

data/README.md

@@ -1,5 +1,7 @@
 # Simpacker
 
+[![Build Status](https://travis-ci.org/hokaccha/simpacker.svg?branch=master)](https://travis-ci.org/hokaccha/simpacker) [![Gem Version](https://badge.fury.io/rb/simpacker.svg)](https://badge.fury.io/rb/simpacker)
+
 Simpacker provides the feature to integrate modern JavaScript build system with Rails, like a [webpacker](https://github.com/rails/webpacker).
 
 ## Installation
@@ -7,7 +9,7 @@ Simpacker provides the feature to integrate modern JavaScript build system with
 Create a new rails application without webpacker.
 
 ```
-$ rails new myapp
+$ rails new myapp --skip-javascript
 ```
 
 Add this line to your application's Gemfile:
@@ -31,12 +33,43 @@ Add `javascript_pack_tag` in view.
 Run the folloing command to build JavaScript.
 
 ```
-$ ./node_modules/.bin/wabpack --watch
+$ ./node_modules/.bin/webpack --watch
 ```
 
-## Integrations
-
-See [examples](https://github.com/hokaccha/simpacker/tree/master/example).
+## Examples
+
+- Webpack settings
+  - [webpack-dev-server](https://github.com/hokaccha/simpacker/tree/master/example/webpack-dev-server)
+  - [Multiple Entry Point](https://github.com/hokaccha/simpacker/tree/master/example/multiple-entry-points)
+  - [Split Chunks](https://github.com/hokaccha/simpacker/tree/master/example/split-chunks)
+- Transpilers
+  - [TypeScript](https://github.com/hokaccha/simpacker/tree/master/example/typescript)
+  - [Babel](https://github.com/hokaccha/simpacker/tree/master/example/babel)
+- Style Sheets
+  - [CSS](https://github.com/hokaccha/simpacker/tree/master/example/css)
+  - [Sass](https://github.com/hokaccha/simpacker/tree/master/example/sass)
+  - [PostCSS](https://github.com/hokaccha/simpacker/tree/master/example/postcss)
+- Frameworks
+  - [React(TypeScript)](https://github.com/hokaccha/simpacker/tree/master/example/react-typescript)
+  - [React(Babel)](https://github.com/hokaccha/simpacker/tree/master/example/react-babel)
+  - [Vue.js](https://github.com/hokaccha/simpacker/tree/master/example/vue)
+  - [Angular](https://github.com/hokaccha/simpacker/tree/master/example/angular)
+- Deployment
+  - [CDN](https://github.com/hokaccha/simpacker/tree/master/example/asset-host)
+  - [Heroku](https://github.com/hokaccha/simpacker/tree/master/example/heroku)
+  - [Docker](https://github.com/hokaccha/simpacker/tree/master/example/docker)
+- Advanced settings
+  - [Rails Engines](https://github.com/hokaccha/simpacker/tree/master/example/engines)
+- Bundler
+  - [Parcel](https://github.com/hokaccha/simpacker/tree/master/example/parcel)
+
+## VS. Webpacker
+
+Webpacker is a great product that you can easily use webpack without knowing it. It also provides many useful features. The difficulty with Webpacker is that you need to configure webpack via webpacker's own DSL and webpacker.yml. If you know how to configure webpack, you need to convert it to webpacker configuration. I want to edit webpack.config.js directly!
+
+Simpacker provides only minimal features that lookup the manifest.json output by webpack and a create script tag through javascript_pack_tag. You need to know about webpack, but there is little to know about Simpacker.
+
+However, some useful features of Webpacker, such as yarn integrity and compilation on request, are not available in Simpacker.
 
 ## Deployment
 
@@ -47,6 +80,8 @@ $ npm install
 $ NODE_ENV=production ./node_modules/.bin/webpack
 ```
 
+See also: [CDN](https://github.com/hokaccha/simpacker/tree/master/example/asset-host), [Heroku](https://github.com/hokaccha/simpacker/tree/master/example/heroku), [Docker](https://github.com/hokaccha/simpacker/tree/master/example/docker)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/hokaccha/simpacker.

data/lib/install/javascript/greeter.js

@@ -0,0 +1,3 @@
+export function hello(name) {
+  return `Hello ${name}!`;
+}

data/lib/install/root/webpack.config.js

@@ -8,26 +8,20 @@ module.exports = {
   mode: isProd ? "production" : "development",
   devtool: "source-map",
   entry: {
-    application: path.resolve(__dirname, "app/javascript/application.ts")
+    application: path.resolve(__dirname, "app/javascript/application.js"),
   },
   output: {
     path: path.resolve(__dirname, "public/packs"),
     publicPath: "/packs/",
-    filename: isProd ? "[name]-[hash].js" : "[name].js"
+    filename: isProd ? "[name]-[hash].js" : "[name].js",
   },
   resolve: {
-    extensions: [".js", ".ts"]
+    extensions: [".js"],
   },
-  module: {
-    rules: [
-      {
-        test: /\.tsx?$/,
-        loader: "ts-loader",
-        options: {
-          transpileOnly: true
-        }
-      }
-    ]
-  },
-  plugins: [new WebpackAssetsManifest({ publicPath: true })]
+  plugins: [
+    new WebpackAssetsManifest({
+      publicPath: true,
+      output: "manifest.json",
+    }),
+  ],
 };

data/lib/install/template.rb

@@ -1,7 +1,6 @@
 puts "Copying config files"
 copy_file "#{__dir__}/config/simpacker.yml", "config/simpacker.yml"
 copy_file "#{__dir__}/root/webpack.config.js", "webpack.config.js"
-copy_file "#{__dir__}/root/tsconfig.json", "tsconfig.json"
 
 unless File.exist?('package.json')
   copy_file "#{__dir__}/root/package.json", "package.json"
@@ -24,8 +23,6 @@ dep_packages = %w(
   webpack
   webpack-cli
   webpack-assets-manifest
-  typescript
-  ts-loader
 ).join(' ')
 
 say "Installing npm packages"

data/lib/simpacker/configuration.rb

@@ -1,39 +1,14 @@
-require "yaml"
-
 module Simpacker
   class Configuration
-    attr_accessor :root_path, :config_path, :env
-
-    def initialize(root_path:)
-      @root_path = root_path
-      @config_path = @root_path.join("config/simpacker.yml")
-      @env = Rails.env
-    end
+    attr_accessor :manifest_path, :cache_manifest
 
-    def manifest_path
-      root_path.join(data.fetch("manifest_path"))
+    def initialize(manifest_path:, cache_manifest: true)
+      @manifest_path = manifest_path
+      @cache_manifest = cache_manifest
     end
 
     def cache_manifest?
-      data.fetch("cache_manifest")
-    end
-
-    private
-
-    def data
-      @data ||= load
-    end
-
-    def load
-      YAML.load(config_path.read)[env]
-    rescue Errno::ENOENT => e
-      raise "Simpacker configuration file not found #{config_path}. " \
-            "Please run rails simpacker:install " \
-            "Error: #{e.message}"
-    rescue Psych::SyntaxError => e
-      raise "YAML syntax error occurred while parsing #{config_path}. " \
-            "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
-            "Error: #{e.message}"
+      !!cache_manifest
     end
   end
 end

data/lib/simpacker/context.rb

@@ -1,10 +1,33 @@
+require "yaml"
+
 module Simpacker
   class Context
+    class InvalidConfigurationError < StandardError; end
+
     attr_reader :config, :manifest
 
-    def initialize(root_path: Rails.root)
-      @config = Simpacker::Configuration.new(root_path: root_path)
-      @manifest = Simpacker::Manifest.new(self)
+    def initialize(root_path: Rails.root, env: Rails.env)
+      config = load_config_file(root_path, env)
+      @config = Simpacker::Configuration.new(**config)
+      @manifest = Simpacker::Manifest.new(@config)
+    end
+
+    private
+
+    def load_config_file(root_path, env)
+      config_path = root_path.join("config/simpacker.yml")
+      yaml = YAML.load(config_path.read)
+      config_env = yaml.fetch(env.to_s)
+      {
+        manifest_path: root_path.join(config_env.fetch('manifest_path')),
+        cache_manifest: config_env.fetch('cache_manifest'),
+      }
+    rescue Errno::ENOENT
+      raise Simpacker::Context::InvalidConfigurationError, "Simpacker configuration file not found #{config_path}"
+    rescue KeyError => err
+      raise Simpacker::Context::InvalidConfigurationError, "Missing field: `#{err.key}` in #{config_path}"
+    rescue Psych::SyntaxError => err
+      raise Simpacker::Context::InvalidConfigurationError, "YAML syntax error occurred while parsing #{config_path}. Error: #{err.message}"
     end
   end
 end

data/lib/simpacker/helper.rb

@@ -26,6 +26,14 @@ module Simpacker
       image_tag(asset_path(simpacker_context.manifest.lookup!(name)), **options)
     end
 
+    def image_pack_url(name, **options)
+      asset_url(simpacker_context.manifest.lookup!(name), **options)
+    end
+
+    def favicon_pack_tag(name, **options)
+      favicon_link_tag(asset_path(simpacker_context.manifest.lookup!(name)), **options)
+    end
+
     def simpacker_context
       Simpacker.default_context
     end

data/lib/simpacker/manifest.rb

@@ -1,29 +1,30 @@
 module Simpacker
   class Manifest
     class MissingEntryError < StandardError; end
+    class MissingFileError < StandardError; end
 
-    attr_reader :context
+    attr_reader :config
 
-    def initialize(context)
-      @context = context
+    def initialize(config)
+      @config = config
     end
 
-    def lookup(name)
-      data[name.to_s].presence
+    def lookup(*names)
+      data.dig(*names.map(&:to_s))
     end
 
-    def lookup!(name)
-      lookup(name) || handle_missing_entry(name)
+    def lookup!(*names)
+      lookup(*names) || handle_missing_entry(names)
     end
 
     private
 
-    def handle_missing_entry(name)
-      raise Simpacker::Manifest::MissingEntryError
+    def handle_missing_entry(names)
+      raise Simpacker::Manifest::MissingEntryError, "Missing field: #{names.join('.')}"
     end
 
     def data
-      if context.config.cache_manifest?
+      if config.cache_manifest?
         @data ||= load
       else
         load
@@ -31,10 +32,10 @@ module Simpacker
     end
 
     def load
-      if context.config.manifest_path.exist?
-        JSON.parse(context.config.manifest_path.read)
+      if config.manifest_path.exist? && config.manifest_path.file?
+        JSON.parse(config.manifest_path.read)
       else
-        {}
+        raise Simpacker::Manifest::MissingFileError, "Missing manifest file: #{config.manifest_path}"
       end
     end
   end

data/lib/simpacker/version.rb

@@ -1,3 +1,3 @@
 module Simpacker
-  VERSION = "0.3.0"
+  VERSION = "1.2.0"
 end

data/package.json

@@ -0,0 +1,9 @@
+{
+  "private": true,
+  "scripts": {
+    "format": "prettier --list-different --write '**/*.{js,ts,jsx,tsx}'"
+  },
+  "devDependencies": {
+    "prettier": "^2.2.1"
+  }
+}

data/simpacker.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "railties", ">= 4.2"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rails", "~> 5.2"
-  spec.add_development_dependency "minitest", "~> 5.1"
+  spec.add_development_dependency "bundler", ">= 1.16"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rails", ">= 5.2"
+  spec.add_development_dependency "minitest", ">= 5.1"
 end

data/yarn.lock

@@ -0,0 +1,8 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+prettier@^2.2.1:
+  version "2.2.1"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.2.1.tgz#795a1a78dd52f073da0cd42b21f9c91381923ff5"
+  integrity sha512-PqyhM2yCjg/oKkFPtTGUojv7gnZAoG80ttl45O6x2Ug/rMJw4wcc9k6aaf2hibP7BGVCCM33gZoGjyvt9mm16Q==

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simpacker
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kazuhito Hokamura
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-29 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -28,56 +28,56 @@ dependencies:
   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: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
 description: Integrate modern JavaScript build system with Rails.
@@ -88,16 +88,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".prettierignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/install/config/simpacker.yml
-- lib/install/javascript/application.ts
-- lib/install/javascript/greeter.ts
+- lib/install/javascript/application.js
+- lib/install/javascript/greeter.js
 - lib/install/root/package.json
-- lib/install/root/tsconfig.json
 - lib/install/root/webpack.config.js
 - lib/install/template.rb
 - lib/simpacker.rb
@@ -108,12 +110,14 @@ files:
 - lib/simpacker/railtie.rb
 - lib/simpacker/version.rb
 - lib/tasks/simpacker.rake
+- package.json
 - simpacker.gemspec
+- yarn.lock
 homepage: https://github.com/hokaccha/simpacker
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,8 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Integrate modern JavaScript build system with Rails.
 test_files: []

data/lib/install/javascript/greeter.ts

@@ -1,3 +0,0 @@
-export function hello(name: string): string {
-  return `Hello ${name}!`;
-}

data/lib/install/root/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es5",
-    "lib": ["es2019", "dom", "dom.iterable"],
-    "module": "es2015",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "downlevelIteration": true,
-    "sourceMap": true,
-    "removeComments": false,
-    "noImplicitAny": false,
-    "strictNullChecks": true,
-    "strictFunctionTypes": true,
-    "strictBindCallApply": true,
-    "strictPropertyInitialization": true,
-    "noImplicitThis": true
-  }
-}