embedded_js 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d602e1be0a18713a73864169b04f97bb63b7a270b5daf38f42f78ba263e50e51
+  data.tar.gz: fe41d9e37a3d6cbec78e79611b7824cc4af69b9bfdaec47f3f9f76976de876c4
+SHA512:
+  metadata.gz: 401906b148300ce29681569c042f587cf4fa49b40d968cc79dbb05d35846d4158c22494963b2398732918987917b7e6c10fcee5a1ece3dd12cfc26f491836e85
+  data.tar.gz: fb6adc8d3deb68f3567313909aa144e4cb6cd6c348d63d57099eb7d62dda114e0734d9f838f75808e6e65c9533d35c100dee9c4c15fda294a667c6d37ff62200

data/README.md

@@ -0,0 +1,76 @@
+# EmbeddedJs
+
+`EmbeddedJs` is a gem to support including JavaScript packages in your Rails Engines.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'embedded_js'
+```
+
+And then execute:
+
+    $ bundle install
+
+Finally, run the generator:
+
+    $ rails generate embedded_js:install
+
+## Usage
+
+It works by hooking into the JavaScript package managers preinstall hook via a Rake task. The Rake task copies the `files` specified in the `package.json` to a temporary directory and then install that directory as a local package.
+
+### Configuration
+
+```ruby
+require 'embedded_js'
+
+EmbeddedJs.configure do |config|
+  config.package_manager = :npm
+  config.engines = %w[
+      engine1
+      engine2
+  ]
+end
+
+```
+
+#### Configuration Options
+
+Option/Method | Description
+--- | ---
+`package_manager` | The package manager you are using with your application. Currently supports `:npm` and `:yarn`. (default: `:npm`)
+`engine` | An array of the names of the gems/engines to include.
+
+### Preinstall Hook
+
+You'll need to add the `preinstall` script to your applications `package.json` in the `scripts` property.
+
+```json
+{
+  "scripts": {
+    "preinstall": "bundle exec rails embedded_js:preinstall"
+  }
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aaricpittman/embedded-js. 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/aaricpittman/embedded-js/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Webpacker::Engine project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aaricpittman/embedded-js/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/embeddedjs

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'embedded_js'
+
+EmbeddedJs::Cli.start(ARGV)

data/lib/embedded_js.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'embedded_js/version'
+require 'embedded_js/config'
+require 'embedded_js/cli'
+
+module EmbeddedJs
+  def self.config
+    @config ||= Config.load
+  end
+
+  def self.gem_specs
+    @gem_specs ||= Bundler.load.specs
+  end
+end

data/lib/embedded_js/adaptors/command_runner.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module EmbeddedJs
+  module Adaptors
+    class CommandRunner
+      def initialize(io: Open3)
+        @io = io
+      end
+
+      def run(cmd, environment_variables = {})
+        io.popen3(
+          environment_variables,
+          "#{cmd} 2>&1"
+        ) do |stdin, stdout, _stderr, wait_thread|
+          stdin.close_write
+
+          while line = stdout.gets
+            puts line
+          end
+
+          puts wait_thread.value
+        end
+      end
+
+      private
+
+      attr_reader :io
+    end
+  end
+end

data/lib/embedded_js/adaptors/io.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tmpdir'
+
+module EmbeddedJs
+  module Adaptors
+    class IO
+      def copy_files(files:, to:)
+        FileUtils.cp_r(
+          files,
+          to,
+          preserve: true
+        )
+      end
+
+      def exists?(path:)
+        File.exist?(path)
+      end
+
+      def mkdir(path:)
+        FileUtils.mkdir_p(path)
+      end
+
+      def tmpdir
+        Dir.tmpdir
+      end
+    end
+  end
+end

data/lib/embedded_js/cli.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+require_relative 'commands/init'
+require_relative 'commands/preinstall'
+
+module EmbeddedJs
+  class Cli < Thor
+    desc 'init', 'Generates EmbeddedJs configuration.'
+    option :package_manager,
+           desc: 'Specify the JavaScript package manager to configure. (yarn, npm)',
+           type: :string,
+           default: 'npm'
+    def init
+      Commands::Init.call(package_manager: options[:package_manager])
+    end
+
+    desc 'preisntall', 'Installs configured js packages embedded in gems.'
+    def preinstall
+      Commands::Preinstall.call(gems: EmbeddedJs.config.gems)
+    end
+  end
+end

data/lib/embedded_js/commands/init.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module EmbeddedJs
+  module Commands
+    class Init
+      TEMPLATES_DIR = File.expand_path('../../templates', __dir__)
+      CONFIG_OUTPUT_PATH = './.embeddedjs'
+
+      class << self
+        def call(package_manager: 'npm')
+          new.call(package_manager: package_manager)
+        end
+      end
+
+      def call(package_manager: 'npm')
+        @package_manager = package_manager
+
+        generate_config_file
+        instructions
+      end
+
+      private
+
+      attr_reader :package_manager
+
+      def generate_config_file
+        File.write(CONFIG_OUTPUT_PATH, render_config)
+      end
+
+      def instructions
+        post_install_msg = File.read("#{TEMPLATES_DIR}/post_install.txt")
+
+        puts post_install_msg
+      end
+
+      def config_template
+        File.read(config_template_path)
+      end
+
+      def config_template_path
+        "#{TEMPLATES_DIR}/.embeddedjs.erb"
+      end
+
+      def render_config
+        ERB.new(config_template).result(binding)
+      end
+    end
+  end
+end

data/lib/embedded_js/commands/preinstall.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative '../adaptors/command_runner'
+require_relative '../gem_package'
+require_relative '../package_managers/factory'
+
+module EmbeddedJs
+  module Commands
+    class Preinstall
+      ENV_VARIABLE_NAME = 'EP_PREINSTALL'
+
+      class << self
+        def call(gems:)
+          new.call(gems: gems)
+        end
+      end
+
+      def initialize(
+        command_runner: Adaptors::CommandRunner.new,
+        package_manager: PackageManagers::Factory.build(EmbeddedJs.config.package_manager)
+      )
+        @command_runner = command_runner
+        @package_manager = package_manager
+      end
+
+      def call(gems:)
+        return if ENV.fetch(ENV_VARIABLE_NAME, nil)
+
+        gems.each(&method(:install_embedded_package))
+      end
+
+      private
+
+      attr_reader :command_runner, :package_manager
+
+      def install_embedded_package(gem)
+        embedded_jsage = GemPackage.new(gem)
+
+        embedded_jsage.with_path do |path|
+          command_runner.run(
+            package_manager.install_command(path),
+            { ENV_VARIABLE_NAME => '1' }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/embedded_js/config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module EmbeddedJs
+  class Config
+    DEFAULT_CONFIG_PATH = './.embeddedjs'
+
+    class << self
+      def load(config_path: DEFAULT_CONFIG_PATH)
+        new(**JSON.parse(File.read(config_path), symbolize_names: true))
+      end
+    end
+
+    attr_accessor :package_manager, :gems
+
+    def initialize(package_manager: :npm, gems: [])
+      @gems = gems
+      @package_manager = package_manager.to_sym
+    end
+  end
+end

data/lib/embedded_js/gem_package.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'adaptors/io'
+require_relative 'package_config'
+
+module EmbeddedJs
+  class GemPackage
+    def initialize(
+      engine,
+      io: Adaptors::IO.new,
+      package_config: PackageConfig.new(EmbeddedJs.gem_specs.find { |s| s.name == engine }&.full_gem_path)
+    )
+      @engine = engine
+      @io = io
+      @package_config = package_config
+    end
+
+    def with_path
+      io.mkdir(path: tmp_path)
+      copy_specified_files(tmp_path)
+
+      yield tmp_path
+    end
+
+    private
+
+    attr_reader :engine, :gem_specs, :io, :package_config
+
+    def copy_specified_files(dir)
+      io.copy_files(
+        files: package_config.package_files_paths,
+        to: dir
+      )
+    end
+
+    def package_json?
+      io.exist?(path: "#{engine_path}/package.json")
+    end
+
+    def tmp_path
+      "#{io.tmpdir}/EmbeddedJs/#{engine}"
+    end
+  end
+end

data/lib/embedded_js/package_config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module EmbeddedJs
+  class PackageConfig
+    attr_reader :path
+
+    def initialize(package_path)
+      @path = package_path
+
+      raise ArgumentError, "#{package_path} does not have a package.json file." unless File.exist?(config_path)
+
+      @config = JSON.parse(File.read(config_path))
+    end
+
+    def package_files_paths
+      specified_files.map { |f| "#{path}/#{f}" }.tap do |paths|
+        paths << config_path unless paths.include?(config_path)
+      end
+    end
+
+    private
+
+    attr_reader :config
+
+    def config_path
+      "#{path}/package.json"
+    end
+
+    def specified_files
+      config.fetch('files', [])
+    end
+  end
+end

data/lib/embedded_js/package_managers/factory.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'npm'
+require_relative 'yarn'
+
+module EmbeddedJs
+  module PackageManagers
+    class Factory
+      class << self
+        def build(name)
+          case name
+          when :npm then PackageManagers::Npm.new
+          when :yarn then PackageManagers::Yarn.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/embedded_js/package_managers/npm.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module EmbeddedJs
+  module PackageManagers
+    class Npm
+      INSTALL_COMMAND = 'npm install %<engine_path>s'
+
+      def install_command(engine_path)
+        format(INSTALL_COMMAND, engine_path: engine_path)
+      end
+    end
+  end
+end

data/lib/embedded_js/package_managers/yarn.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module EmbeddedJs
+  module PackageManagers
+    class Yarn
+      INSTALL_COMMAND = 'yarn add file:%<engine_path>s'
+
+      def install_command(engine_path)
+        format(INSTALL_COMMAND, engine_path: engine_path)
+      end
+    end
+  end
+end

data/lib/embedded_js/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EmbeddedJs
+  VERSION = '0.1.0'
+end

data/lib/templates/post_install.txt

@@ -0,0 +1,9 @@
+
+===============================================================================
+
+Add the following to your package.json scripts:
+
+  "preinstall": "bundle exec embeddedjs preinstall"
+
+===============================================================================
+

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: embedded_js
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaric Pittman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- aaricpittman@gmail.com
+executables:
+- embeddedjs
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- exe/embeddedjs
+- lib/embedded_js.rb
+- lib/embedded_js/adaptors/command_runner.rb
+- lib/embedded_js/adaptors/io.rb
+- lib/embedded_js/cli.rb
+- lib/embedded_js/commands/init.rb
+- lib/embedded_js/commands/preinstall.rb
+- lib/embedded_js/config.rb
+- lib/embedded_js/gem_package.rb
+- lib/embedded_js/package_config.rb
+- lib/embedded_js/package_managers/factory.rb
+- lib/embedded_js/package_managers/npm.rb
+- lib/embedded_js/package_managers/yarn.rb
+- lib/embedded_js/version.rb
+- lib/templates/post_install.txt
+homepage: https://github.com/aaricpittman/embedded-js
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aaricpittman/embedded-js
+  source_code_uri: https://github.com/aaricpittman/embedded-js
+  changelog_uri: https://github.com/aaricpittman/embedded-js/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Simplifies including JavaScript packages in your Rails Engines.
+test_files: []