tinypacker 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aa21621f6b5dc2c5a2825bf8f326ae9cc8285c6a05798b5295ddcd9dcf888dd
-  data.tar.gz: 91fb379bafe29dedb5d532fc489e5f4d61e13aead22a36f17f99bb6838baf0c0
+  metadata.gz: 06acf7757df545c98d3a0b8dd2456df838ad5703796a69910a0c8fb33dbbb1e9
+  data.tar.gz: 8e506319646a4e60dbbfd392a353db0e026591063b75d0f070da73fea08b76c4
 SHA512:
-  metadata.gz: b3642f682bb1fb81b1c4de898fcd73ab0c37e4d70666b19c8f04771a539f5722d7753f31e1f65a48b8535de5e3d5540849dd2d48181247f4d8f5daa0a8c92087
-  data.tar.gz: 597f80979de7e0ff202c6fda106e368f5d209866a513d3d8a5088de6801b9a6285f253e61476601c161b66d00bc77dfb7e9b8ed61bf78b1fc0bbb3dbbe0a03c5
+  metadata.gz: 60ef145be61223969d2e0a3d1de33bca57f2395e91d5a5f5d704c36a4908dfe4fc3a3c8593d8d58ce85c0b3bc2d0d63211ac92e1f1b142a5144d68c48aad3224
+  data.tar.gz: 4fc4ff31dfda69e22d5dffeb2ced10085c6e92723bc826939bbb34e245ca9a59ede36092a40b898d7ac60b19cd8b4a9e70283ef60ddc3cde8bc05e3ecf020d74

data/README.md

@@ -18,9 +18,27 @@ Or install it yourself as:
 
     $ gem install tinypacker
 
+Finally, run the following to install 
+
+    $ bundle exec rails tinypacker:install
+
 ## Usage
 
-TODO: Write usage instructions here
+As with Webpacker, an asset manifest file is required to use Tinypacker. You need to specify the path of the asset manifest file in `manifest_path` of `tinypacker.yml`.
+
+The format of the asset manifest file is as follows:
+
+```json
+{
+  "application.js": "/packs/js/application-12345.js",
+}
+```
+
+And on the view file, you can use `javascript_pack_tag`.
+
+```
+<%= javascript_pack_tag 'application.js' %>
+```
 
 ## Development
 
@@ -30,7 +48,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tinypacker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tinypacker/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/taogawa/tinypacker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/taogawa/tinypacker/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -38,4 +56,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Tinypacker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tinypacker/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Tinypacker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/taogawa/tinypacker/blob/main/CODE_OF_CONDUCT.md).

data/lib/install/config/tinypacker.yml

@@ -0,0 +1,14 @@
+default: &default
+  manifest_path: public/packs/manifest.json
+
+development:
+  <<: *default
+  cache_manifest: false
+
+test:
+  <<: *default
+  cache_manifest: false
+
+production:
+  <<: *default
+  cache_manifest: true

data/lib/install/template.rb

@@ -0,0 +1,10 @@
+# Install Tinypacker
+copy_file "#{__dir__}/config/tinypacker.yml", "config/tinypacker.yml"
+
+if File.exists?(".gitignore")
+  append_to_file ".gitignore" do
+    "\n/public/packs\n"
+  end
+end
+
+say "Tinypacker successfully installed", :green

data/lib/tasks/install.rake

@@ -0,0 +1,9 @@
+install_template_path = File.expand_path("../install/template.rb", __dir__).freeze
+bin_path = ENV["BUNDLE_BIN"] || "./bin"
+
+namespace :tinypacker do
+  desc "Install Tinypacker in this application"
+  task :install do
+    exec "#{RbConfig.ruby} #{bin_path}/rails app:template LOCATION=#{install_template_path}"
+  end
+end

data/lib/tinypacker/version.rb

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

data/lib/tinypacker.rb

@@ -9,9 +9,9 @@ module Tinypacker
     @instance ||= Tinypacker::Instance.new
   end
 
-  class Error < StandardError; end
-
   class Manifest
+    class FileNotFoundError < ::StandardError; end
+
     def initialize(configuration)
       @configuration = configuration
     end
@@ -25,7 +25,7 @@ module Tinypacker
     def load
       JSON.parse(File.read(@configuration.manifest_path))
     rescue Errno::ENOENT => e
-      raise Tinypacker::Error, "manifest file not found #{@configuration.manifest_path}. Error: #{e.message}"
+      raise Tinypacker::Manifest::FileNotFoundError, "manifest file not found #{@configuration.manifest_path}. Error: #{e.message}"
     end
 
     def data
@@ -49,6 +49,9 @@ module Tinypacker
   end
 
   class Configuration
+    class FileNotFoundError < ::StandardError; end
+    class SyntaxError < ::StandardError; end
+
     attr_reader :root_path, :config_path
 
     def initialize(root_path:, env: Rails.env)
@@ -76,9 +79,9 @@ module Tinypacker
       end
       config[@env].deep_symbolize_keys
     rescue Errno::ENOENT => e
-      raise Tinypacker::Error, "Tinypacker configuration file not found #{config_path}. Error: #{e.message}"
+      raise Tinypacker::Configuration::FileNotFoundError, "Tinypacker configuration file not found #{config_path}. Error: #{e.message}"
     rescue Psych::SyntaxError => e
-      raise Tinypacker::Error, "YAML syntax error occurred while parsing #{config_path}. Error: #{e.message}"
+      raise Tinypacker::Configuration::SyntaxError, "YAML syntax error occurred while parsing #{config_path}. Error: #{e.message}"
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tinypacker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - taogawa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-28 00:00:00.000000000 Z
+date: 2022-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -95,6 +95,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/install/config/tinypacker.yml
+- lib/install/template.rb
+- lib/tasks/install.rake
 - lib/tinypacker.rb
 - lib/tinypacker/version.rb
 - sig/tinypacker.rbs