simpacker 0.2.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e51ab5eb4741f00ae413fcc931027a066dc596d52e45b4e200c196feea7e0ee
-  data.tar.gz: 110c2a023025c0891be42412f656f3dde456e5b1572ad40a96fed1c319d8e1b5
+  metadata.gz: 0523cb48ed8bb338019021e9fb4a1753f891cc2a02b314204641f78751bef706
+  data.tar.gz: 11ba83077029dc703d72d8bdeca29967fb93326805a03f0c463e311cd3f075c5
 SHA512:
-  metadata.gz: a3ac94fb02775f05cadf37ae24cbd78de58157f8594991bd9cf32b2a609881c28893ca5701feb82c178323323c7c24d5f32b14a095e88e35b1f04dfe90e804b8
-  data.tar.gz: c62c4db865dae9f3a0ccf87e70d755f6b08148e797b97a1e16dba2c12874165f9738ec036056ebc14ff6294ca68d35c16e20ed7743fd3944d314a7eed4d65a1b
+  metadata.gz: c8359e0a9512f9ac4cd3afd44ae2471b777d33dd89b9493265951e12a82acc8b4e6f27b8a6acc456a2e9fdf62e2cd655f3e3d792897af1803657be24d6fe5b41
+  data.tar.gz: 8b6b9d1326a9da1e1439240acaecd77e7fd2f8cf114c66d19b4fcb02fde7c72a7d2a8479411afc85cc6b8a2c0adb6e35714459da2ee80e98c3e510250b348af4

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 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.
 
 ```
-$ npx 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)
+- 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)
+  - [Custom helper](https://github.com/hokaccha/simpacker/tree/master/example/custom-helper)
+- 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
 
@@ -44,9 +77,11 @@ Simpacker does not provide feature for deployment. Just run the following comman
 
 ```
 $ npm install
-$ NODE_ENV=production npx webpack
+$ 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,27 +8,15 @@ 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",
-    chunkFilename: "[id]-[chunkhash].js"
+    filename: isProd ? "[name]-[hash].js" : "[name].js"
   },
   resolve: {
-    extensions: [".js", ".ts"]
-  },
-  module: {
-    rules: [
-      {
-        test: /\.tsx?$/,
-        loader: "ts-loader",
-        options: {
-          transpileOnly: true
-        }
-      }
-    ]
+    extensions: [".js"]
   },
   plugins: [new WebpackAssetsManifest({ publicPath: true })]
 };

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.rb

@@ -1,14 +1,11 @@
+require "simpacker/context"
 require "simpacker/configuration"
 require "simpacker/manifest"
 require "simpacker/helper"
 require "simpacker/railtie"
 
 module Simpacker
-  def self.config
-    @config ||= Simpacker::Configuration.new
-  end
-
-  def self.manifest
-    @manifest ||= Simpacker::Manifest.new(config)
+  def self.default_context
+    @default_context ||= Simpacker::Context.new
   end
 end

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 = Rails.root
-      @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

@@ -0,0 +1,33 @@
+require "yaml"
+
+module Simpacker
+  class Context
+    class InvalidConfigurationError < StandardError; end
+
+    attr_reader :config, :manifest
+
+    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

@@ -2,28 +2,32 @@ module Simpacker
   module Helper
     def javascript_pack_tag(*names, **options)
       sources = names.map do |name|
-        Simpacker.manifest.lookup!("#{name}#{compute_asset_extname(name.to_s, type: :javascript)}")
+        simpacker_context.manifest.lookup!("#{name}#{compute_asset_extname(name.to_s, type: :javascript)}")
       end
       javascript_include_tag(*sources, **options)
     end
 
     def stylesheet_pack_tag(*names, **options)
       sources = names.map do |name|
-        Simpacker.manifest.lookup!("#{name}#{compute_asset_extname(name.to_s, type: :stylesheet)}")
+        simpacker_context.manifest.lookup!("#{name}#{compute_asset_extname(name.to_s, type: :stylesheet)}")
       end
       stylesheet_link_tag(*sources, **options)
     end
 
     def asset_pack_path(name, **options)
-      asset_path(Simpacker.manifest.lookup!(name), **options)
+      asset_path(simpacker_context.manifest.lookup!(name), **options)
     end
 
     def asset_pack_url(name, **options)
-      asset_url(Simpacker.manifest.lookup!(name), **options)
+      asset_url(simpacker_context.manifest.lookup!(name), **options)
     end
 
     def image_pack_tag(name, **options)
-      image_tag(asset_path(Simpacker.manifest.lookup!(name)), **options)
+      image_tag(asset_path(simpacker_context.manifest.lookup!(name)), **options)
+    end
+
+    def simpacker_context
+      Simpacker.default_context
     end
   end
 end

data/lib/simpacker/manifest.rb

@@ -1,6 +1,7 @@
 module Simpacker
   class Manifest
     class MissingEntryError < StandardError; end
+    class MissingFileError < StandardError; end
 
     attr_reader :config
 
@@ -8,18 +9,18 @@ module Simpacker
       @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
@@ -31,10 +32,10 @@ module Simpacker
     end
 
     def load
-      if config.manifest_path.exist?
+      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.2.0"
+  VERSION = "1.1.1"
 end

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simpacker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Kazuhito Hokamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-23 00:00:00.000000000 Z
+date: 2020-07-08 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,20 +88,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".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
 - lib/simpacker/configuration.rb
+- lib/simpacker/context.rb
 - lib/simpacker/helper.rb
 - lib/simpacker/manifest.rb
 - lib/simpacker/railtie.rb
@@ -127,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Integrate modern JavaScript build system with Rails.

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
-  }
-}