gakubuchi 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d5aac84118b90bfe6ff298c120189aa4561e4cd
-  data.tar.gz: f963f5d180b747be66a68bdbac981520ee3c3fad
+  metadata.gz: 0e79a372af60dae91f7a2800bf92105775443301
+  data.tar.gz: f5f85209a9cbb2d8d051f184e56daa6509ceb1a9
 SHA512:
-  metadata.gz: ca7f0bbff7e8d4d0a1d72f7272f01ed37a5a2336249251882c675810091f7b60b63f2a3c72270c6ab841f71e694c936598d01ecaa875618a68220c234545065a
-  data.tar.gz: 1a1127e8783cff92e2b546a7dcabad8f67d8dc6e77db62c852b768eb0c10a86e633e0e456eba5ec64074a3ebe7f040ab9d17f573d9789ca105a035901cdd3adc
+  metadata.gz: e5ad244af5a0a6d1294b953e9869252329c5b12a80c605956330dd91c273dbda10acf15531808d37380eb31f363a0f642b5442e2adf56a6a81850cdc40b9e1bc
+  data.tar.gz: a63cba1baa07b640d5ce4d2645cc5646133a30a9b7c5a1d418dac7b73d5424e63804df31a4ffa55b561010f06942194ca9085dea948f2cd67ba2e5bdb8579946

data/README.md

@@ -17,13 +17,13 @@ gem 'gakubuchi'
 Run the installation generator with:
 
 ```shell
-rails generate gakubuchi:install
+rails g gakubuchi:install
 ```
 
 Or specify the name of directory for static pages:
 
 ```shell
-rails generate gakubuchi:install -d html
+rails g gakubuchi:install -d html
 ```
 
 They will install the initializer into `config/initializers/gakubuchi.rb` and create the directory in `app/assets`.  
@@ -57,21 +57,21 @@ http://localhost:3000/assets/404.html
 Compile the templeate with:
 
 ```shell
-rake assets:precompile
+rails assets:precompile
 ```
 
 This will generate `public/404.html`.
 
 ## Template engines
 Gakubuchi supports some template engines: `ERB`, `Haml` and `Slim`.  
-If you want to use `Haml` or `Slim`, you need to put them in your Gemfile:
+When you want to use `Haml` or `Slim`, you need to put them in your Gemfile:
 
 ```ruby
 # Use Haml
-gem 'haml-rails'
+gem 'haml'
 
 # Use Slim
-gem 'slim-rails'
+gem 'slim'
 ```
 
 ## Using assets
@@ -111,9 +111,9 @@ You should follow the steps below.
 
 1. [Fork the repository](https://help.github.com/articles/fork-a-repo/)
 2. Create a feature branch: `git checkout -b add-new-feature`
-3. Commit your changes: `git commit -am 'add new feature'`
+3. Commit your changes: `git commit -am 'Add new feature'`
 4. Push the branch: `git push origin add-new-feature`
-4. [Send us a pull request](https://help.github.com/articles/using-pull-requests/)
+4. [Send us a pull request](https://help.github.com/articles/about-pull-requests/)
 
 We use [Appraisal](https://github.com/thoughtbot/appraisal) to test with different combinations of
 [sprockets](https://github.com/rails/sprockets) and [sprockets-rails](https://github.com/rails/sprockets-rails).
@@ -123,7 +123,7 @@ bundle install
 appraisal install
 
 # Run RSpec with a specific combination
-appraisal 'sprockets-rails 3 with sprockets 3' rspec
+appraisal 'sprockets-rails 3 with sprockets 4' rspec
 
 # Run RSpec with all combinations
 appraisal rspec

data/lib/gakubuchi.rb

@@ -1,35 +1,5 @@
-require "fileutils"
-require "forwardable"
-require "logger"
-require "active_support/configurable"
-
+# frozen_string_literal: true
 require "gakubuchi/configuration"
-require "gakubuchi/error"
-require "gakubuchi/fileutils"
+require "gakubuchi/railtie"
 require "gakubuchi/task"
 require "gakubuchi/version"
-
-if defined?(::Rails::Railtie) && defined?(::Sprockets::Railtie)
-  require "pathname"
-  require "gakubuchi/engine_registrar"
-  require "gakubuchi/template"
-  require "gakubuchi/railtie"
-end
-
-module Gakubuchi
-  class << self
-    attr_writer :configuration
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    def configure
-      yield(configuration) if block_given?
-    end
-
-    def reset
-      @configuration = nil
-    end
-  end
-end

data/lib/gakubuchi/configuration.rb

@@ -1,4 +1,24 @@
+# frozen_string_literal: true
+require "active_support/configurable"
+require "forwardable"
+
 module Gakubuchi
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= ::Gakubuchi::Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def reset
+      @configuration = nil
+    end
+  end
+
   class Configuration
     extend ::Forwardable
     include ::ActiveSupport::Configurable

data/lib/gakubuchi/engine_registrar.rb

@@ -1,30 +1,54 @@
+# frozen_string_literal: true
+require "active_support/inflector"
+require "grease"
+require "sprockets"
+
 module Gakubuchi
   class EngineRegistrar
+    EXTENSION_WITH_SIGLE_DOT = /\A\.[^\.]+\z/
+
     def initialize(env)
       @env = env
     end
 
-    def register(target, engine)
-      klass = constantize(engine)
-      return false if !klass.instance_of?(::Class) || registered?(target)
+    def register(mime_type, engine_name_or_class)
+      engine = constantize(engine_name_or_class)
+      return false if !engine.instance_of?(::Class) || mime_type.extensions.empty?
 
-      args = [target, klass]
-      args << { silence_deprecation: true } if Sprockets::VERSION.start_with?("3")
+      if sprockets_major_version >= 4
+        register_as_transformer(mime_type, engine)
+      else
+        register_as_engine(mime_type, engine)
+      end
 
-      @env.register_engine(*args)
       true
     end
 
-    def registered?(target)
-      @env.engines.key?(::Sprockets::Utils.normalize_extension(target))
-    end
-
     private
 
-    def constantize(klass)
-      klass.to_s.constantize
+    def constantize(constant_name)
+      constant_name.to_s.constantize
     rescue ::LoadError, ::NameError
       nil
     end
+
+    def sprockets_major_version
+      @sprockets_major_version ||= ::Gem::Version.new(::Sprockets::VERSION).segments.first
+    end
+
+    def register_as_engine(mime_type, engine)
+      mime_type.extensions.select { |ext| ext =~ EXTENSION_WITH_SIGLE_DOT }.each do |ext|
+        args = [ext, engine]
+        args << { silence_deprecation: true } if sprockets_major_version == 3
+        @env.register_engine(*args)
+      end
+    end
+
+    def register_as_transformer(mime_type, engine)
+      content_type = mime_type.content_type
+
+      @env.register_mime_type(content_type, extensions: mime_type.extensions)
+      @env.register_transformer(content_type, engine.default_mime_type, ::Grease.apply(engine))
+    end
   end
 end

data/lib/gakubuchi/error.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 module Gakubuchi
-  class Error < StandardError
-    InvalidTemplate = Class.new(self)
+  class Error < ::StandardError
+    InvalidTemplate = ::Class.new(self)
+    InvalidMimeType = ::Class.new(self)
   end
 end

data/lib/gakubuchi/fileutils.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+require "fileutils"
+require "logger"
+
 module Gakubuchi
   module FileUtils
     extend ::FileUtils

data/lib/gakubuchi/mime_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require "gakubuchi/error"
+require "set"
+
+module Gakubuchi
+  class MimeType
+    CONTENT_TYPE_FORMAT = %r(\A[^/]+/[^/]+\z)
+
+    attr_reader :content_type, :extensions
+
+    def initialize(content_type, extensions: [])
+      unless content_type =~ CONTENT_TYPE_FORMAT
+        message = %(`#{content_type}' is invalid as Content-Type)
+        raise ::Gakubuchi::Error::InvalidMimeType, message
+      end
+
+      @content_type = content_type
+      @extensions = ::Set.new(extensions).map(&:to_s)
+    end
+  end
+end

data/lib/gakubuchi/railtie.rb

@@ -1,10 +1,26 @@
+# frozen_string_literal: true
+require "gakubuchi/engine_registrar"
+require "gakubuchi/mime_type"
+require "gakubuchi/template"
+require "rails/railtie"
+require "sprockets/railtie"
+
 module Gakubuchi
   class Railtie < ::Rails::Railtie
     config.assets.configure do |env|
-      engine_registrar = EngineRegistrar.new(env)
+      engine_registrar = ::Gakubuchi::EngineRegistrar.new(env)
+
+      haml = ::Gakubuchi::MimeType.new("text/haml", extensions: %w(.haml .html.haml))
+      engine_registrar.register(haml, "Tilt::HamlTemplate")
+
+      slim = ::Gakubuchi::MimeType.new("text/slim", extensions: %w(.slim .html.slim))
+      engine_registrar.register(slim, "Slim::Template")
+    end
 
-      engine_registrar.register(:haml, "::Tilt::HamlTemplate")
-      engine_registrar.register(:slim, "::Slim::Template")
+    config.after_initialize do
+      # NOTE: Call #to_s for Sprockets 4 or later
+      templates = ::Gakubuchi::Template.all.map { |template| template.logical_path.to_s }
+      config.assets.precompile += templates
     end
 
     rake_tasks do

data/lib/gakubuchi/rake_task.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require "gakubuchi/task"
+require "rake"
+require "rake/tasklib"
+require "sprockets/railtie"
+
+rake_tasks do
+  ::Gakubuchi::RakeTask.new do |task|
+    task.templates = %w(foo.slim bar.slim)
+  end
+end
+
+module Gakubuchi
+  class RakeTask < ::Rake::TaskLib
+    attr_accessor :templates
+
+    def initialize(target_task = "assets:precompile")
+      self.target_task = target_task
+      self.templates = []
+      self.verbose = true
+
+      yield self if block_given?
+      enhance_target_task
+    end
+
+    def task
+      @task ||= ::Gakubuchi::Task.new(templates, verbose: verbose)
+    end
+
+    private
+
+    def enhance_target_task
+      ::Rake::Task[target_task].enhance { task.execute! }
+    end
+  end
+end

data/lib/gakubuchi/task.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+require "gakubuchi/configuration"
+require "gakubuchi/fileutils"
+
 module Gakubuchi
   class Task
     attr_reader :templates
@@ -12,9 +16,11 @@ module Gakubuchi
         next if src.nil?
 
         dest = template.destination_path
-        FileUtils.copy_p(src, dest)
+        ::Gakubuchi::FileUtils.copy_p(src, dest)
 
-        FileUtils.remove([src, *::Dir.glob("#{src}.gz")]) unless leave_digest_named_templates?
+        unless leave_digest_named_templates?
+          ::Gakubuchi::FileUtils.remove([src, *::Dir.glob("#{src}.gz")])
+        end
       end
     end
 

data/lib/gakubuchi/template.rb

@@ -1,3 +1,11 @@
+# frozen_string_literal: true
+require "forwardable"
+require "gakubuchi/configuration"
+require "gakubuchi/error"
+require "pathname"
+require "rails"
+require "sprockets/railtie"
+
 module Gakubuchi
   class Template
     extend ::Forwardable
@@ -28,9 +36,9 @@ module Gakubuchi
 
       case
       when !@extname.include?("html")
-        fail Error::InvalidTemplate, "source path must refer to a template file"
+        raise ::Gakubuchi::Error::InvalidTemplate, "source path must refer to a template file"
       when !@source_path.fnmatch?(root.join("*").to_s)
-        fail Error::InvalidTemplate, "template must exist in #{root}"
+        raise ::Gakubuchi::Error::InvalidTemplate, "template must exist in #{root}"
       end
     end
 
@@ -39,7 +47,8 @@ module Gakubuchi
     end
 
     def digest_path
-      asset = assets.find_asset(logical_path)
+      # NOTE: Call #to_s for Sprockets 4 or later
+      asset = assets.find_asset(logical_path.to_s)
       return if asset.nil?
 
       ::Pathname.new(::File.join(::Rails.public_path, app.config.assets.prefix, asset.digest_path))

data/lib/gakubuchi/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Gakubuchi
-  VERSION = "1.3.0".freeze
+  VERSION = "1.4.0".freeze
 end

data/lib/generators/gakubuchi/install/install_generator.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+require "gakubuchi/configuration"
+require "pathname"
+require "rails/generators/base"
+
 module Gakubuchi
   module Generators
     class InstallGenerator < ::Rails::Generators::Base

data/lib/tasks/after_precompile.rake

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+require "gakubuchi/task"
+require "gakubuchi/template"
+
 Rake::Task["assets:precompile"].enhance do
   task = Gakubuchi::Task.new(Gakubuchi::Template.all)
   task.execute!

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gakubuchi
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - yasaichi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: grease
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +112,16 @@ dependencies:
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -154,16 +168,16 @@ dependencies:
   name: slim-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +207,9 @@ files:
 - lib/gakubuchi/engine_registrar.rb
 - lib/gakubuchi/error.rb
 - lib/gakubuchi/fileutils.rb
+- lib/gakubuchi/mime_type.rb
 - lib/gakubuchi/railtie.rb
+- lib/gakubuchi/rake_task.rb
 - lib/gakubuchi/task.rb
 - lib/gakubuchi/template.rb
 - lib/gakubuchi/version.rb