simpacker 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e23b7c5891f8dd786aeb87c9ffe96ffb523869165a2e7ba3f6092530f6fe555c
-  data.tar.gz: f9c22f0d68c5642f2f8fcb7cad20811aba7a792a0f3d461da1ee177400ffee4d
+  metadata.gz: 91a0259d16d447c35740fe2261d8666a3f014da6e469c64cae1922465351c05f
+  data.tar.gz: f16ac990f0e689751069256b909afa54e41688638bfbefd5cd409b1ed6dddab9
 SHA512:
-  metadata.gz: 84e25b65c83b399fb97fbb586d4f6bf324eeef0a93e7524a0eed978498b0f435ac56e4e3a4c16e85206f55379cd51ae685d9aa74b293840dedeb65f3b08a8e82
-  data.tar.gz: 7e20cd2635db6e5afeabd72c98f6a3b613236f00032be79df011fe59f771c53b2441304607f154e9bba7607322c9aa87dd4f1cd337fa09fa6241c2364e557287
+  metadata.gz: 7f41ace4633df97ef72573dd524b3b47f9d9784b0f81db0ec19d76c5c21c4e86ae6ac0dbce60b36043fa6d346187fe6ccadd9216e5168150f603c501025db69a
+  data.tar.gz: 321c5eb359a553499b29272ee2067ae8ff663bf46e4171480435b65630342803c7fec06483bbaed556a610bb969efc42e9b203b7fbaa695fa96c3c542ec03a95

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 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

@@ -41,9 +41,11 @@ $ ./node_modules/.bin/wabpack --watch
 - 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)
-- Languages
+- 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)
 - Frameworks
   - [React](https://github.com/hokaccha/simpacker/tree/master/example/react)
@@ -53,8 +55,10 @@ $ ./node_modules/.bin/wabpack --watch
   - [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)
-- Others
+- 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

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,7 +8,7 @@ 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"),
@@ -16,18 +16,7 @@ module.exports = {
     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/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/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 = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simpacker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kazuhito Hokamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-02 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -89,16 +89,16 @@ 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

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