catalyst-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f4062e6e325a8a191e435eb75e272cb7746c863ad9d75f1b6d274f5d41a5433
+  data.tar.gz: 34c8cd4232f14da1d9c06af6c70e6cc363f7c5d20b3a1b151766156a9b18f15e
+SHA512:
+  metadata.gz: a5f6edf6124e90a195fcb36e08548b3c5e04d368ea4f9550a0671903eec576e0011cac87275c392b7a85049fd9f722bdcbb370e56ae7306030dc98c378fa2cca
+  data.tar.gz: 9a75fb0d529bdeb052f7eabf7ac9d17fbceb2d83ba5c1a41d30a3d4b98eb6724e8bc6fb354e00b344b7a17e16cac4710bf26201728ca33a0a93c9f000c79660c

data/lib/catalyst-rails.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'dry-configurable'
+require 'open3'
+
+module Catalyst
+  extend Dry::Configurable
+
+  default_environment = if ENV['NODE_ENV']
+    ENV['NODE_ENV'].to_sym
+  elsif defined? Rails
+    Rails.env.to_sym
+  end
+
+  default_manifest_path = if defined? Rails
+    File.expand_path('./public/assets/manifest.json', Dir.pwd)
+  end
+
+  setting :environment, default_environment
+  setting :manifest_path, default_manifest_path
+  setting :assets_base_path, '/assets'
+  setting :dev_server_host, ENV.fetch('DEV_SERVER_HOST') { 'localhost' }
+  setting :dev_server_port, ENV.fetch('DEV_SERVER_PORT') { 8080 }.to_i
+  setting :running_feature_tests, -> {
+    !defined?(RSpec) || RSpec.world.all_example_groups.any? do |group|
+      group.metadata[:type] == :system
+    end
+  }
+
+  def self.log(message, level = :info)
+    message = message.split("\n").reduce('') do |reduction, line|
+      reduction + "\e[31m[Catalyst]\e[0m #{line}\n"
+    end
+
+    puts message
+  end
+
+  def self.development?
+    config.environment == :development
+  end
+
+  def self.test?
+    config.environment == :test
+  end
+
+  def self.production?
+    config.environment == :production
+  end
+
+  def self.build!(environment = nil)
+    ::Catalyst::Builder.build!(environment)
+  end
+
+  def self.serve!
+    unless $catalyst_server_pid.nil?
+      log(
+        "A Catalyst server is already running (#{$catalyst_server_pid}).",
+        :warn
+      )
+
+      return
+    end
+
+    check_for_catalyst!
+
+    stdin, stdout, stderr, wait_thr = Open3.popen3('yarn start')
+
+    $catalyst_server_pid = wait_thr.pid
+
+    Thread.new do
+      while line = stdout.gets
+        puts line
+      end
+    rescue IOError
+    end
+
+    at_exit do
+      stdin.close
+      stdout.close
+      stderr.close
+    end
+  end
+
+  def self.check_for_yarn!
+    unless system 'which yarn > /dev/null 2>&1'
+      raise NotInstalled, <<~MESSAGE
+        The yarn binary is not available in this directory.
+        Please follow the instructions here to install it:
+        https://yarnpkg.com/lang/en/docs/install
+      MESSAGE
+    end
+  end
+
+  def self.check_for_catalyst!
+    check_for_yarn!
+
+    unless system 'yarn run which catalyst > /dev/null 2>&1'
+      raise NotInstalled, <<~MESSAGE
+        The catalyst binary is not available in this directory.
+        Please follow the instructions here to intall it:
+        https://github.com/friendsoftheweb/catalyst
+      MESSAGE
+    end
+  end
+end
+
+require_relative './catalyst/errors'
+require_relative './catalyst/builder'
+require_relative './catalyst/helpers'
+require_relative './catalyst/manifest'
+require_relative './catalyst/railtie' if defined? Rails

data/lib/catalyst/builder.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'forwardable'
+require_relative './config'
+
+module Catalyst
+  class Builder
+    BUILD_COMMAND = 'yarn run catalyst build'
+
+    include Singleton
+
+    class << self
+      extend Forwardable
+      def_delegator :instance, :build!
+    end
+
+    def build!(environment = nil)
+      Catalyst.check_for_catalyst!
+
+      environment ||= Catalyst.config.environment
+
+      case environment
+      when :test
+        test_build!
+      when :production
+        production_build!
+      else
+        raise ArgumentError,
+              'Invalid environment. Must be one of: :test, :production.'
+      end
+    end
+
+    private
+
+    def test_build!
+      unless Catalyst.config.running_feature_tests.call
+        Catalyst.log('Not running feature tests -- skipping build')
+        return
+      end
+
+      # Only rebuild the assets if they've been modified since the last time
+      # they were built successfully.
+      if assets_last_built >= assets_last_modified
+        Catalyst.log('Assets have not been modified -- skipping build')
+        return
+      end
+
+      if system("NODE_ENV=test #{BUILD_COMMAND}")
+        unless assets_last_built_file_path.nil?
+          FileUtils.touch(assets_last_built_file_path)
+        end
+      else
+        puts <<~MESSAGE
+          \e[31m
+          ***************************************************************
+          *                                                             *
+          *          Failed to compile assets with Catalyst!            *
+          *  Make sure 'yarn run catalyst build' runs without failing.  *
+          *                                                             *
+          ***************************************************************\e[0m
+        MESSAGE
+
+        exit 1
+      end
+    end
+
+    def production_build!
+      unless system("NODE_ENV=production #{BUILD_COMMAND}")
+        Catalyst.log('Failed to compile assets!')
+      end
+    end
+
+    def assets_last_modified
+      asset_paths.lazy.map { |path| File.ctime(path) }.max || Time.now
+    end
+
+    def asset_paths
+      if ::Catalyst::Config.root_path
+        Dir.glob(File.join(::Catalyst::Config.root_path, '**/*.{js,scss}')) + [
+          File.join(Dir.pwd, 'yarn.lock')
+        ]
+      else
+        []
+      end
+    end
+
+    def assets_last_built_file_path
+      if defined?(Rails)
+        Rails.root.join('tmp/assets-last-built')
+      end
+    end
+
+    def assets_last_built
+      if assets_last_built_file_path.nil?
+        Time.at(0)
+      else
+        File.mtime(assets_last_built_file_path) rescue Time.at(0)
+      end
+    end
+  end
+end

data/lib/catalyst/config.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'forwardable'
+require 'json'
+require_relative './errors'
+
+module Catalyst
+  class Config
+    PACKAGE_PATH = File.expand_path('./package.json', Dir.pwd)
+
+    include Singleton
+
+    class << self
+      extend Forwardable
+      def_delegators :instance, :root_path, :build_path
+    end
+
+    def initialize
+      unless File.exists?(PACKAGE_PATH)
+        raise ::Catalyst::MissingConfig,
+              "Missing package.json file in: #{Dir.pwd}"
+      end
+
+      @values = JSON.parse(File.read(PACKAGE_PATH))['catalyst']
+
+      if @values.nil?
+        raise ::Catalyst::MissingConfig, <<~MESSAGE
+          Missing "catalyst" config in package.json file.
+          Please follow the instructions here to set up Catalyst:
+          https://github.com/friendsoftheweb/catalyst
+        MESSAGE
+      end
+    end
+
+    def root_path
+      File.join(Dir.pwd, @values['rootPath'])
+    end
+
+    def build_path
+      File.join(Dir.pwd, @values['buildPath'])
+    end
+  end
+end

data/lib/catalyst/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Catalyst
+  CatalystError = Class.new(StandardError)
+  NotInstalled = Class.new(CatalystError)
+  MissingConfig = Class.new(CatalystError)
+end

data/lib/catalyst/helpers.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require_relative './manifest'
+
+module Catalyst
+  module Helpers
+    include ActionView::Helpers::TagHelper
+
+    def catalyst_javascript_vendor_include_tag
+      if Catalyst.development?
+        content_tag(:script, nil, src: ::Catalyst::Manifest['vendor-dll.js'])
+      end
+    end
+
+    def catalyst_javascript_include_tag(path)
+      path = path.to_s.gsub(/\.js\z/, '')
+
+      content_tag(
+        :script,
+        nil,
+        src: ::Catalyst::Manifest["#{path}.js"],
+        type: 'text/javascript'
+      )
+    end
+
+    def catalyst_stylesheet_link_tag(path)
+      path = path.to_s.gsub(/\.css\z/, '')
+
+      unless Catalyst.development?
+        content_tag(
+          :link,
+          nil,
+          href: ::Catalyst::Manifest["#{path}.css"],
+          media: 'screen',
+          rel: 'stylesheet'
+        )
+      end
+    end
+
+    def catalyst_asset_path(path)
+      ::Catalyst::Manifest[path]
+    end
+
+    def catalyst_asset_url(path)
+      if Catalyst.development? || ENV['HOST'].blank?
+        webpack_asset_path(path)
+      else
+        "https://#{ENV['HOST']}#{webpack_asset_path(path)}"
+      end
+    end
+  end
+end

data/lib/catalyst/manifest.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'forwardable'
+
+module Catalyst
+  class Manifest
+    AssetMissing = Class.new(StandardError)
+
+    include Singleton
+
+    class << self
+      extend Forwardable
+      def_delegator :instance, :[]
+    end
+
+    def initialize
+      if Catalyst.development?
+        @manifest = {}
+      else
+        if Catalyst.config.manifest_path.nil?
+          raise 'Missing "manifest_path" configuration.'
+        end
+
+        @manifest = JSON.parse(File.read(Catalyst.config.manifest_path))
+      end
+    end
+
+    def [](path)
+      path = path.to_s.gsub(/\A\/+/, '')
+
+      if Catalyst.development?
+        dev_server_host = Catalyst.config.dev_server_host
+        dev_server_port = Catalyst.config.dev_server_port
+
+        if dev_server_host.nil?
+          raise 'Missing "dev_server_host" configuration.'
+        end
+
+        if dev_server_port.nil?
+          raise 'Missing "dev_server_port" configuration.'
+        end
+
+        return "http://#{dev_server_host}:#{dev_server_port}/#{path}"
+      else
+        if @manifest.key?(path)
+          assets_base_path = Catalyst.config.assets_base_path
+
+          if assets_base_path.nil?
+            raise 'Missing "assets_base_path" configuration.'
+          end
+
+          return "#{assets_base_path}/#{@manifest[path]}"
+        else
+          raise AssetMissing, "Couldn't find an asset for path: #{path}"
+        end
+      end
+    end
+  end
+end

data/lib/catalyst/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative './helpers'
+
+module Catalyst
+  class Railtie < Rails::Railtie
+    initializer 'catalyst_rails.view_helpers' do
+      ActionView::Base.include(::Catalyst::Helpers)
+    end
+
+    rake_tasks do
+      load File.expand_path('./tasks/build.rake', __dir__)
+    end
+  end
+end

data/lib/catalyst/tasks/build.rake

@@ -0,0 +1,22 @@
+namespace :catalyst do
+  desc 'Build assets with Catalyst'
+  task :build do
+    if File.exists?('./public/assets/manifest.json')
+      puts "[Catalyst] Removing previous assets..."
+
+      manifest = JSON.parse(File.read('./public/assets/manifest.json'))
+
+      manifest.values.each do |asset_path|
+        system "rm -f ./public/assets/#{asset_path}*"
+      end
+    end
+
+    puts "[Catalyst] Compiling assets..."
+    Catalyst.build!
+
+    if Catalyst.production?
+      puts "[Catalyst] Removing 'node_modules' directory..."
+      system 'rm -rf ./node_modules'
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: catalyst-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: 
+email: dan@friendsoftheweb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/catalyst-rails.rb
+- lib/catalyst/builder.rb
+- lib/catalyst/config.rb
+- lib/catalyst/errors.rb
+- lib/catalyst/helpers.rb
+- lib/catalyst/manifest.rb
+- lib/catalyst/railtie.rb
+- lib/catalyst/tasks/build.rake
+homepage: http://rubygems.org/gems/catalyst-rails
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Ruby helpers for the "catalyst" node package
+test_files: []