gakubuchi 0.2.2 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1edba3f60856d88e7f5529bdbce93eecc0a35313
-  data.tar.gz: 32a2cf35012a653ca428642c13b1a0bc3583a7a9
+  metadata.gz: 24f1923fe8e330d09cd3297d4eab8eb3707417c8
+  data.tar.gz: 6b6960e650da43d042f666c8dcee139ec5e50664
 SHA512:
-  metadata.gz: b813c7f0e3745f402df939554df6bdd047ded8387ea81fc74dae8d12042f468dd5f1e94dae5519aa894adce4695c5488106bbb71ae8b33f1627f75c227262c8b
-  data.tar.gz: 933d064cf2693a53698e4809cc1824e5de2976d05ade332fa31ddc99efb67ebe395b58911034d3535bdcf767b3fcb7480472902362dc084e4543739fee9ed016
+  metadata.gz: 76a1cafe291e2264a0832315fbc501bb9afc590187f6546bc59510b8b7e8c7509e0647b37f05881bd8a9a89d5c94cf9b30df45e63206d6f21b9d298b2a214244
+  data.tar.gz: e2e8e17b243aae14a0ec7ed71ddb02278bab8eb5dc93f666ad29de35f175aec2fca5ec0f6e8a347fa95f9fe5f87b87e691300178a7f020a1e49b4858d9e806cc

data/README.md

@@ -7,13 +7,30 @@
 
 Gakubuchi provides a simple way to manage static pages (e.g. error pages) with Asset Pipeline.
 
-## Quickstart
+## Installation
 Put this in your Gemfile:
 
 ```ruby
 gem 'gakubuchi'
 ```
 
+Run the installation generator with:
+
+```shell
+rails generate gakubuchi:install
+```
+
+Or specify the name of directory for static pages:
+
+```shell
+rails generate gakubuchi:install -d html
+```
+
+They will install the initializer into `config/initializers/gakubuchi.rb` and create the directory in `app/assets`.  
+If you don't specify the `-d` option, `templates` will be used as default.
+
+## Usage
+
 In `app/assets/templates/404.html.slim`:
 
 ```slim
@@ -43,7 +60,7 @@ Compile the templeate with:
 rake assets:precompile
 ```
 
-Then, you can get `public/404.html`.
+This will generate `public/404.html`.
 
 ## Template engines
 Gakubuchi supports some template engines: `ERB`, `Haml` and `Slim`.  
@@ -57,20 +74,20 @@ gem 'haml-rails'
 gem 'slim-rails'
 ```
 
-## Configuration
-First, run the installation generator with:
+## Using assets
+Gakubuchi enables you to use assets (e.g. `CSS` or `JavaScript` files) in static pages.  
+Note that you may need to add them to the precompile array in `config/initializers/assets.rb`:
 
-```shell
-rails generate gakubuchi:install
+```ruby
+Rails.application.config.assets.precompile += %w(error.css error.js)
 ```
 
-This will install the initializer into `config/initializers/gakubuchi.rb`.
-
-In the file, you can configure the following values.
+## Configuration
+In `config/initializers/gakubuchi.rb`, you can configure the following values.
 
 ```
 remove_precompiled_templates # true by default
-template_root                # 'app/assets/templates' by default
+template_directory           # 'templates' by default
 ```
 
 ## Supported versions

data/lib/gakubuchi.rb

@@ -1,11 +1,19 @@
-require 'rails'
+require 'fileutils'
+require 'forwardable'
+require 'logger'
+require 'active_support/configurable'
 
 require 'gakubuchi/configuration'
+require 'gakubuchi/fileutils'
 require 'gakubuchi/task'
-require 'gakubuchi/template'
-require 'gakubuchi/template_engine'
 require 'gakubuchi/version'
-require 'gakubuchi/engine'
+
+if defined?(::Rails::Railtie) && defined?(::Sprockets::Railtie)
+  require 'pathname'
+  require 'gakubuchi/template'
+  require 'gakubuchi/template_engine'
+  require 'gakubuchi/railtie'
+end
 
 module Gakubuchi
   class << self

data/lib/gakubuchi/configuration.rb

@@ -1,14 +1,17 @@
 module Gakubuchi
   class Configuration
-    include ActiveSupport::Configurable
-    alias_method :to_h, :config
+    extend ::Forwardable
+    include ::ActiveSupport::Configurable
+
+    private :config
+    def_delegators :config, :to_h
 
     config_accessor :remove_precompiled_templates do
       true
     end
 
-    config_accessor :template_root do
-      'app/assets/templates'
+    config_accessor :template_directory do
+      'templates'
     end
   end
 end

data/lib/gakubuchi/fileutils.rb

@@ -1,12 +1,10 @@
-require 'fileutils'
-
 module Gakubuchi
   module FileUtils
     extend ::FileUtils
 
     class << self
       def copy_p(src, dest)
-        mkdir_p(File.dirname(dest))
+        mkdir_p(::File.dirname(dest))
         copy(src, dest)
         logging("Copied #{src} to #{dest}")
       end
@@ -19,7 +17,7 @@ module Gakubuchi
       private
 
       def logging(message)
-        Logger.new(STDOUT).info(message)
+        ::Logger.new(STDOUT).info(message)
       end
     end
   end

data/lib/gakubuchi/{engine.rb → railtie.rb}

@@ -1,14 +1,12 @@
 module Gakubuchi
-  class Engine < ::Rails::Engine
-    isolate_namespace Gakubuchi
-
-    config.generators do |g|
-      g.test_framework :rspec
-    end
-
+  class Railtie < ::Rails::Railtie
     initializer 'gakubuchi.assets.precompile' do |app|
       TemplateEngine.new('Slim::Template').register!('.slim')
       TemplateEngine.new('Tilt::HamlTemplate').register!('.haml')
     end
+
+    rake_tasks do
+      ::Dir.glob(::File.expand_path('../../tasks/*.rake', __FILE__)).each { |path| load path }
+    end
   end
 end

data/lib/gakubuchi/task.rb

@@ -1,5 +1,3 @@
-require 'gakubuchi/fileutils'
-
 module Gakubuchi
   class Task
     attr_reader :templates
@@ -10,18 +8,13 @@ module Gakubuchi
 
     def execute!
       templates.each do |template|
-        precompiled_pathnames = template.precompiled_pathnames
-
-        src = precompiled_pathnames
-          .select  { |pathname| pathname.extname == '.html' }
-          .sort_by { |pathname| pathname.mtime }
-          .last
-
+        src = template.precompiled_pathname
         next if src.nil?
-        dest = template.destination_pathname
 
+        dest = template.destination_pathname
         FileUtils.copy_p(src, dest)
-        FileUtils.remove(precompiled_pathnames) if remove_precompiled_templates?
+
+        FileUtils.remove(src) if remove_precompiled_templates?
       end
     end
 

data/lib/gakubuchi/template.rb

@@ -13,24 +13,20 @@ module Gakubuchi
     end
 
     def self.all
-      Dir.glob(root.join('**/*.html*')).map { |path| new(path) }
+      ::Dir.glob(root.join('**/*.html*')).map { |path| new(path) }
     end
 
     def self.root
-      Rails.root.join(Gakubuchi.configuration.template_root)
+      ::Rails.root.join('app/assets', Gakubuchi.configuration.template_directory)
     end
 
     def initialize(path)
-      @pathname = Pathname.new(path)
-    end
-
-    def basename
-      pathname.basename.to_s
+      @pathname = ::Pathname.new(path)
     end
 
     def destination_pathname
       dirname = relative_pathname.dirname
-      Rails.public_path.join(dirname, "#{relative_pathname.basename(extname)}.html")
+      ::Rails.public_path.join(dirname, "#{relative_pathname.basename(extname)}.html")
     end
 
     def extname
@@ -48,11 +44,9 @@ module Gakubuchi
       extnames.join
     end
 
-    def precompiled_pathnames
-      dirname = relative_pathname.dirname
-      pattern = "#{relative_pathname.basename(extname)}-*.{html,html.gz}"
-
-      Pathname.glob(Rails.public_path.join('assets', dirname, pattern))
+    def precompiled_pathname
+      asset = ::Rails.application.assets.find_asset(relative_pathname)
+      ::Rails.public_path.join('assets', asset.digest_path) if asset
     end
 
     def relative_pathname

data/lib/gakubuchi/template_engine.rb

@@ -5,8 +5,8 @@ module Gakubuchi
     attr_reader :klass
     alias_method :engine, :klass
 
-    def_delegators 'Rails.application', :assets
-    def_delegators 'Sprockets::Utils', :normalize_extension
+    def_delegators '::Rails.application', :assets
+    def_delegators '::Sprockets::Utils', :normalize_extension
     private :assets, :normalize_extension
 
     def initialize(engine)

data/lib/gakubuchi/version.rb

@@ -1,3 +1,3 @@
 module Gakubuchi
-  VERSION = '0.2.2'
+  VERSION = '1.0.0.rc2'
 end

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

@@ -1,10 +1,23 @@
 module Gakubuchi
   module Generators
-    class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
+    class InstallGenerator < ::Rails::Generators::Base
+      DEFAULT_DIRECTORY = Gakubuchi::Configuration.new.template_directory.freeze
+
+      desc 'Create a Gakubuchi initializer.'
+      source_root ::File.expand_path('../templates', __FILE__)
+
+      class_option :directory,
+        type: :string,
+        aliases: '-d',
+        default: DEFAULT_DIRECTORY,
+        desc: 'Name of directory for templates'
 
       def copy_initializer_file
-        copy_file 'gakubuchi.rb', 'config/initializers/gakubuchi.rb'
+        template 'gakubuchi.rb', 'config/initializers/gakubuchi.rb'
+      end
+
+      def create_template_directory
+        empty_directory Pathname.new('app/assets').join(options.directory)
       end
     end
   end

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

@@ -3,7 +3,12 @@ Gakubuchi.configure do |config|
   # in public/assets. By default, Gakubuchi removes them after the precompile.
   # config.remove_precompiled_templates = true
 
-  # The directory for static pages you want to manage with Asset Pipeline.
-  # 'app/assets/templates' by default.
-  # config.template_root = 'app/assets/templates'
+  # Name of directory for templates ('<%= DEFAULT_DIRECTORY %>' by default).
+  # Gakubuchi treats "app/assets/#{config.template_directory}" as root directory
+  # for static pages you want to manage with Asset Pipeline.
+  <%- if options.directory.blank? || options.directory == DEFAULT_DIRECTORY -%>
+  # config.template_directory = '<%= DEFAULT_DIRECTORY %>'
+  <%- else -%>
+  config.template_directory = '<%= options.directory %>'
+  <%- end -%>
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: gakubuchi
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - yasaichi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -132,11 +146,10 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- config/routes.rb
 - lib/gakubuchi.rb
 - lib/gakubuchi/configuration.rb
-- lib/gakubuchi/engine.rb
 - lib/gakubuchi/fileutils.rb
+- lib/gakubuchi/railtie.rb
 - lib/gakubuchi/task.rb
 - lib/gakubuchi/template.rb
 - lib/gakubuchi/template_engine.rb
@@ -156,12 +169,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5

data/config/routes.rb

@@ -1,2 +0,0 @@
-Rails.application.routes.draw do
-end