manifester 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2245e87b983a5959438ada67d8918ee9676594a83f696f7334e390560cc06d1
+  data.tar.gz: b16152e7230c6724889e55e25f55227f1ab870fadbf5ba76721afed39f4a52f4
+SHA512:
+  metadata.gz: 79b6e43a6bd6d4b8cfa4e737d85500dc17a638c01354d8c81e4ee1b1b6589895be5ee57970810568440a6915064b86e11580910f018055c957e0731f4da8fa71
+  data.tar.gz: 61f7553cc4ba9cbfc6514283b4ca3ee46281e7806a7698c5fbb78e4192905cb681af16d1c3ab53c69b7be78e99184b6ca259c2e6cd0cea9083d5254513e02796

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Adrian Marin
+
+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,28 @@
+# Manifester
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'manifester'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install manifester
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,18 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/manifester_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/manifester .css

data/app/assets/stylesheets/manifester/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/manifester/application_controller.rb

@@ -0,0 +1,4 @@
+module Manifester
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/manifester/application_helper.rb

@@ -0,0 +1,24 @@
+module Manifester
+  module ApplicationHelper
+    def current_manifester_instance
+      Manifester.instance
+    end
+
+    def javascript_manifest_tag(*names, **options)
+      javascript_include_tag(*sources_from_manifest_entrypoints(names, type: :javascript), **options)
+    end
+
+    def stylesheet_manifest_tag(*names, **options)
+      stylesheet_link_tag(*sources_from_manifest_entrypoints(names, type: :stylesheet), **options)
+    end
+
+    def stylesheet_pack_tag(*names, **options)
+    end
+
+    private
+
+      def sources_from_manifest_entrypoints(names, type:)
+        names.map { |name| current_manifester_instance.manifest.lookup_pack_with_chunks!(name.to_s, type: type) }.flatten.uniq
+      end
+  end
+end

data/app/jobs/manifester/application_job.rb

@@ -0,0 +1,4 @@
+module Manifester
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/manifester/application_mailer.rb

@@ -0,0 +1,6 @@
+module Manifester
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/manifester/application_record.rb

@@ -0,0 +1,5 @@
+module Manifester
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/manifester/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Manifester</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag "manifester/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Manifester::Engine.routes.draw do
+end

data/lib/install/config/manifester.yml

@@ -0,0 +1,19 @@
+default: &default
+  public_root_path: public
+  public_output_path: packs
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+  compile: true
+
+production:
+  <<: *default
+
+  # Cache manifest.json for performance
+  cache_manifest: true

data/lib/manifester.rb

@@ -0,0 +1,14 @@
+require "manifester/version"
+require "manifester/engine"
+
+module Manifester
+  extend self
+
+  def instance=(instance)
+    @instance = instance
+  end
+
+  def instance
+    @instance ||= Manifester::Instance.new
+  end
+end

data/lib/manifester/configuration.rb

@@ -0,0 +1,57 @@
+require "yaml"
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/hash/indifferent_access"
+
+class Manifester::Configuration
+  attr_reader :root_path, :config_path, :env
+
+  def initialize(root_path:, config_path:, env:)
+    @root_path = root_path
+    @config_path = config_path
+    @env = env
+  end
+
+  def public_path
+    root_path.join(fetch(:public_root_path))
+  end
+
+  def public_output_path
+    public_path.join(fetch(:public_output_path))
+  end
+
+  def public_manifest_path
+    public_output_path.join("manifest.json")
+  end
+
+  def cache_manifest?
+    fetch(:cache_manifest)
+  end
+
+  private
+    def fetch(key)
+      data.fetch(key, defaults[key])
+    end
+
+    def data
+      @data ||= load
+    end
+
+    def load
+      YAML.load(config_path.read)[env].deep_symbolize_keys
+
+    rescue Errno::ENOENT => e
+      raise "Manifester configuration file not found #{config_path}. " \
+            "Please run rails manifester: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}"
+    end
+
+    def defaults
+      @defaults ||= \
+        HashWithIndifferentAccess.new(YAML.load_file(File.expand_path("../../install/config/manifester.yml", __FILE__))[env])
+    end
+end

data/lib/manifester/engine.rb

@@ -0,0 +1,15 @@
+module Manifester
+  class Engine < ::Rails::Engine
+    isolate_namespace Manifester
+
+    initializer "manifester.helper" do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.helper Manifester::ApplicationHelper
+      end
+
+      ActiveSupport.on_load :action_view do
+        include Manifester::ApplicationHelper
+      end
+    end
+  end
+end

data/lib/manifester/env.rb

@@ -0,0 +1,39 @@
+class Manifester::Env
+  DEFAULT = "production".freeze
+
+  delegate :config_path, :logger, to: :@manifester
+
+  def self.inquire(manifester)
+    new(manifester).inquire
+  end
+
+  def initialize(manifester)
+    @manifester = manifester
+  end
+
+  def inquire
+    fallback_env_warning if config_path.exist? && !current
+    current || DEFAULT.inquiry
+  end
+
+  private
+    def current
+      Rails.env.presence_in(available_environments)
+    end
+
+    def fallback_env_warning
+      logger.info "RAILS_ENV=#{Rails.env} environment is not defined in config/manifester.yml, falling back to #{DEFAULT} environment"
+    end
+
+    def available_environments
+      if config_path.exist?
+        YAML.load(config_path.read).keys
+      else
+        [].freeze
+      end
+    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}"
+    end
+end

data/lib/manifester/instance.rb

@@ -0,0 +1,25 @@
+class Manifester::Instance
+  cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
+
+  attr_reader :root_path, :config_path
+
+  def initialize(root_path: Rails.root, config_path: Rails.root.join("config/manifester.yml"))
+    @root_path, @config_path = root_path, config_path
+  end
+
+  def env
+    @env ||= Manifester::Env.inquire self
+  end
+
+  def config
+    @config ||= Manifester::Configuration.new(
+      root_path: root_path,
+      config_path: config_path,
+      env: env
+    )
+  end
+
+  def manifest
+    @manifest ||= Manifester::Manifest.new self
+  end
+end

data/lib/manifester/manifest.rb

@@ -0,0 +1,95 @@
+
+class Manifester::Manifest
+  class MissingEntryError < StandardError; end
+
+  delegate :config, to: :@manifester
+
+  def initialize(manifester)
+    @manifester = manifester
+  end
+
+  def refresh
+    @data = load
+  end
+
+  def lookup_pack_with_chunks(name, pack_type = {})
+    manifest_pack_type = manifest_type(pack_type[:type])
+    manifest_pack_name = manifest_name(name, manifest_pack_type)
+    find("entrypoints")[manifest_pack_name]["assets"][manifest_pack_type]
+  rescue NoMethodError
+    nil
+  end
+
+  def lookup_pack_with_chunks!(name, pack_type = {})
+    lookup_pack_with_chunks(name, pack_type) || handle_missing_entry(name, pack_type)
+  end
+
+  # Computes the relative path for a given Manifester asset using manifest.json.
+  # If no asset is found, returns nil.
+  #
+  # Example:
+  #
+  #   Manifester.manifest.lookup('calendar.js') # => "/packs/calendar-1016838bab065ae1e122.js"
+  def lookup(name, pack_type = {})
+    find(full_pack_name(name, pack_type[:type]))
+  end
+
+  # Like lookup, except that if no asset is found, raises a Manifester::Manifest::MissingEntryError.
+  def lookup!(name, pack_type = {})
+    lookup(name, pack_type) || handle_missing_entry(name, pack_type)
+  end
+
+  private
+    def data
+      if config.cache_manifest?
+        @data ||= load
+      else
+        refresh
+      end
+    end
+
+    def find(name)
+      data[name.to_s].presence
+    end
+
+    def full_pack_name(name, pack_type)
+      return name unless File.extname(name.to_s).empty?
+      "#{name}.#{manifest_type(pack_type)}"
+    end
+
+    def handle_missing_entry(name, pack_type)
+      raise Manifester::Manifest::MissingEntryError, missing_file_from_manifest_error(full_pack_name(name, pack_type[:type]))
+    end
+
+    def load
+      if config.public_manifest_path.exist?
+        JSON.parse config.public_manifest_path.read
+      else
+        {}
+      end
+    end
+
+    # The `manifest_name` method strips of the file extension of the name, because in the
+    # manifest hash the entrypoints are defined by their pack name without the extension.
+    # When the user provides a name with a file extension, we want to try to strip it off.
+    def manifest_name(name, pack_type)
+      return name if File.extname(name.to_s).empty?
+      File.basename(name, ".#{pack_type}")
+    end
+
+    def manifest_type(pack_type)
+      case pack_type
+      when :javascript then "js"
+      when :stylesheet then "css"
+      else pack_type.to_s
+      end
+    end
+
+    def missing_file_from_manifest_error(bundle_name)
+      <<-MSG
+Manifester can't find #{bundle_name} in #{config.public_manifest_path}.
+Your manifest contains:
+#{JSON.pretty_generate(@data)}
+      MSG
+    end
+end

data/lib/manifester/version.rb

@@ -0,0 +1,3 @@
+module Manifester
+  VERSION = '0.1.0'
+end

data/lib/tasks/manifester_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :manifester do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: manifester
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrian Marin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Manifester loads stylesheets and javascript assets from your manifest.json
+  file.
+email:
+- adrian@adrianthedev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/manifester_manifest.js
+- app/assets/stylesheets/manifester/application.css
+- app/controllers/manifester/application_controller.rb
+- app/helpers/manifester/application_helper.rb
+- app/jobs/manifester/application_job.rb
+- app/mailers/manifester/application_mailer.rb
+- app/models/manifester/application_record.rb
+- app/views/layouts/manifester/application.html.erb
+- config/routes.rb
+- lib/install/config/manifester.yml
+- lib/manifester.rb
+- lib/manifester/configuration.rb
+- lib/manifester/engine.rb
+- lib/manifester/env.rb
+- lib/manifester/instance.rb
+- lib/manifester/manifest.rb
+- lib/manifester/version.rb
+- lib/tasks/manifester_tasks.rake
+homepage: https://avohq.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://avohq.io
+  source_code_uri: https://github.com/avo-hq/manifester
+  changelog_uri: https://github.com/avo-hq/manifester
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Manifester loads stylesheets and javascript assets from your manifest.json
+  file.
+test_files: []