themeable 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db4bc5a365caaf437b4570e522968895ec67a6ff
-  data.tar.gz: 010b87b4f96cc921bd8bd9b9662f414b21dd72fa
+  metadata.gz: aa102ec9cc422bf2223a5c7402c3cc989cbc10c2
+  data.tar.gz: 3f9e3d3a8b5d83e79b9f70a7f8266c833760fae9
 SHA512:
-  metadata.gz: f392d1c3542e60a2cc72181bc72db2fd003ffef6f2bfb8af21b3db2e39f280faf0717d02874362c63199c738305594175776947e7eada7a0dad411e49c6f9608
-  data.tar.gz: 26019fbed804bba03dca79d1eae2444ec633db7c73f1a03206fa7f98668469c568d2b9a084c8643588ad8624b1697626d92c3684037c9d220cefe945c18d0080
+  metadata.gz: 3a4c0b7c41f364a13b8c85d1114380e20cbe1a123a76c8232d579b71c6690bc2b44b614d5de8d9ea6a1958b69c4f05e0035ec21e8781d63214cf960eb93ce0f9
+  data.tar.gz: 4fbe6abdd093f6bd0fde85d0a1390dfe2ade05ac9b238ff2158015431793aa97b25c5f34ec83b8e4155b76c668d105ee9ad6ca573f7ae2709e67a48dcfaa1e3b

data/README.md

@@ -39,7 +39,7 @@ Start designing your theme in folder `theme`:
             └── application.html.erb
 
 - theme/assets/my_theme: where your stylesheets and javascripts should put in
-- theme/scaffold_templates/xxx: your scaffold templates, generated default and admin by default, sure you can add more
+- theme/scaffold_templates/xxx: your scaffold templates, generated default and admin by default, of course you can add more if you want
 - theme/views: your views
 
 
@@ -92,12 +92,12 @@ Or, you can make this controller use dynamic themes:
       end
     end
 
-### Use `theme_my_theme` as template engine to scaffold controller views
+### Use `theme_my_theme` as theme to scaffold controller views
 
-    $ rails g scaffold_controller User --template-engine=theme_my_theme --scaffold-template=default
+    $ rails g scaffold_controller User --theme=my_theme
       
         create  app/controllers/users_controller.rb
-        invoke  theme_my_theme
+        invoke  erb
         create    app/views/users
         create    app/views/users/index.html.erb
         create    app/views/users/edit.html.erb
@@ -114,6 +114,21 @@ Or, you can make this controller use dynamic themes:
         create    app/views/users/show.json.jbuilder
         create    app/views/users/_user.json.jbuilder
 
+### Choose scaffold template of theme
+
+There are two templates automatically generated: default and admin
+
+To choose default template, run:
+
+`rails g scaffold_controller User --theme=my_theme --theme-scaffold=default`
+
+To choose admin template, run:
+
+`rails g scaffold_controller User --theme=my_theme --theme-scaffold=admin`
+
+`--theme-scaffold=default` is default value if `--theme-scaffold` is not provided
+
+
 ### Customize `theme_my_theme` in your Rails project
 
 In your Rails project, if you feel `theme_my_theme` is not perfect, and want to make some changes to it only affect current Rails project, instead of all Rails projects which are using gem `theme_my_theme`, now you can do this:
@@ -125,35 +140,32 @@ In your Rails project, if you feel `theme_my_theme` is not perfect, and want to
         create  app/assets/themes/my_theme/application.js
         
     $ rails g theme_my_theme:copy_views
-         exist  app/views
-     identical  app/views/layouts/.gitkeep
-      conflict  app/views/layouts/application.html.erb
-    Overwrite /test_theme/app/views/layouts/application.html.erb? (enter "h" for help) [Ynaqdh] a
-         force  app/views/layouts/application.html.erb
-        create  lib/templates/theme_my_theme/scaffold
-        create  lib/templates/theme_my_theme/scaffold/admin/_form.html.erb
-        create  lib/templates/theme_my_theme/scaffold/admin/edit.html.erb
-        create  lib/templates/theme_my_theme/scaffold/admin/index.html.erb
-        create  lib/templates/theme_my_theme/scaffold/admin/new.html.erb
-        create  lib/templates/theme_my_theme/scaffold/admin/show.html.erb
-        create  lib/templates/theme_my_theme/scaffold/default/_form.html.erb
-        create  lib/templates/theme_my_theme/scaffold/default/edit.html.erb
-        create  lib/templates/theme_my_theme/scaffold/default/index.html.erb
-        create  lib/templates/theme_my_theme/scaffold/default/new.html.erb
-        create  lib/templates/theme_my_theme/scaffold/default/show.html.erb
-
-### Set `theme_my_them` as default template engine
-
-If you feel each time to generate scaffold controller has to provide `--template-engine=theme_my_theme` is annoying, now you can set a default value like this:
-
-in config/application.rb, add `Themeable.template_engine = :my_theme`, note this is `:my_theme` but `:theme_my_theme`, this is different from the value of `--template-engine`
+        create  app/themes/my_theme
+        create  app/themes/my_theme/layouts/.gitkeep
+        create  app/themes/my_theme/layouts/application.html.erb
+        create  lib/templates/erb/scaffold/my_theme/admin/_form.html.erb
+        create  lib/templates/erb/scaffold/my_theme/admin/edit.html.erb
+        create  lib/templates/erb/scaffold/my_theme/admin/index.html.erb
+        create  lib/templates/erb/scaffold/my_theme/admin/new.html.erb
+        create  lib/templates/erb/scaffold/my_theme/admin/show.html.erb
+        create  lib/templates/erb/scaffold/my_theme/default/_form.html.erb
+        create  lib/templates/erb/scaffold/my_theme/default/edit.html.erb
+        create  lib/templates/erb/scaffold/my_theme/default/index.html.erb
+        create  lib/templates/erb/scaffold/my_theme/default/new.html.erb
+        create  lib/templates/erb/scaffold/my_theme/default/show.html.erb
+
+### Set `theme_my_them` as default theme
+
+If you feel each time to generate scaffold controller has to provide `--theme=my_theme` is annoying, now you can set a default value like this:
+
+in config/application.rb, add `Themeable.default_theme = :my_theme`
 
     module TestTheme
       class Application < Rails::Application
 
         ....
 
-        Themeable.template_engine = :my_theme
+        Themeable.default_theme = :my_theme
 
         ...
 

data/lib/themeable/acts_as_themeable.rb

@@ -19,7 +19,9 @@ module Themeable
             view_paths = lookup_context.view_paths.to_a.map(&:to_path)
             theme = Themeable.theme(__themeable_theme_name)
             theme_view_path = File.join(theme.root_path, theme.theme_path, 'views')
-            lookup_context.view_paths = view_paths.insert(1, theme_view_path)
+            view_paths.insert(1, theme_view_path)
+            view_paths.insert(0, Rails.root.join("app/themes/#{theme_name}"))
+            lookup_context.view_paths = view_paths
           end
         RUBY
       end

data/lib/themeable/command.rb

@@ -34,7 +34,6 @@ module Themeable
       # generators
       template 'generators/copy_views_generator.rb', "lib/generators/theme_#{theme_name}/copy_views_generator.rb"
       template 'generators/copy_assets_generator.rb', "lib/generators/theme_#{theme_name}/copy_assets_generator.rb"
-      template 'generators/scaffold_generator.rb', "lib/generators/theme_#{theme_name}/scaffold_generator.rb"
 
       # rakes
       template 'resolve_css_path.rake', "lib/tasks/resolve_css_path.rake"
@@ -53,11 +52,11 @@ Dir.glob('lib/tasks/*.rake').each { |r| load r}
 
       # scaffold templates
       %w(default admin).each do |name|
-        create_file "theme/scaffold_templates/#{name}/index.html.erb"
-        create_file "theme/scaffold_templates/#{name}/edit.html.erb"
-        create_file "theme/scaffold_templates/#{name}/show.html.erb"
-        create_file "theme/scaffold_templates/#{name}/new.html.erb"
-        create_file "theme/scaffold_templates/#{name}/_form.html.erb"
+        create_file "theme/scaffold_templates/#{theme_name}/#{name}/index.html.erb"
+        create_file "theme/scaffold_templates/#{theme_name}/#{name}/edit.html.erb"
+        create_file "theme/scaffold_templates/#{theme_name}/#{name}/show.html.erb"
+        create_file "theme/scaffold_templates/#{theme_name}/#{name}/new.html.erb"
+        create_file "theme/scaffold_templates/#{theme_name}/#{name}/_form.html.erb"
       end
 
       # vender files

data/lib/themeable/generator_concern.rb

@@ -0,0 +1,25 @@
+module Themeable
+  module GeneratorConcern
+    def self.included(klass)
+      klass.instance_eval do
+        class_option :theme, type: :string, desc: "Choose theme to generate files", default: nil
+        class_option :theme_scaffold, type: :string, desc: "Choose a templete to scaffold", default: nil
+      end
+    end
+
+    # Support theme and template
+    def find_in_source_paths(file)
+      theme_scaffold = options[:theme_scaffold]
+      theme_scaffold ||= 'default' if options[:theme].present?
+      themed_file = [options[:theme], theme_scaffold, file].compact.join('/')
+      super(themed_file)
+    rescue Thor::Error => e
+      if e.message =~ /^Could not find /
+        say "Can't find themed file #{themed_file}, use default template", :yellow
+        return super(file)
+      else
+        raise
+      end
+    end
+  end
+end

data/lib/themeable/railtie.rb

@@ -7,8 +7,9 @@ module Themeable
     end
 
     initializer :themeable do
-      config.app_generators.template_engine Themeable.template_engine if Themeable.template_engine
+      config.app_generators.theme = Themeable.default_theme if Themeable.default_theme
       Themeable.themes.each do |theme|
+
         config.assets.paths << File.join(theme.root_path, theme.theme_path, 'assets')
         config.assets.paths << File.join(theme.root_path, 'vendor')
         config.assets.precompile << /\A#{Regexp.escape(theme.theme_name)}\/[^\/]+\.(js|css)\z/
@@ -17,7 +18,12 @@ module Themeable
     end
 
     generators do |app|
-      Rails::Generators::ScaffoldControllerGenerator.class_option :scaffold_template, default: 'default', desc: 'Which scaffold template of themeable plugin you want to use'
+      require 'themeable/generator_concern'
+      require 'rails/generators/erb/scaffold/scaffold_generator'
+      Erb::Generators::ScaffoldGenerator.send :include, Themeable::GeneratorConcern
+      Themeable.themes.each do |theme|
+        Erb::Generators::ScaffoldGenerator.source_paths << File.join(theme.root_path, theme.theme_path, 'scaffold_templates')
+      end
     end
 
   end

data/lib/themeable/theme.rb

@@ -11,7 +11,7 @@ module Themeable
 
       # set default values
       caller_file = caller.first
-      if caller_file =~ %r{/theme_(.+?)/lib/theme_\1\.rb}
+      if caller_file =~ %r{/lib/theme_([^/]*)\.rb}
         default_theme_name = $1.to_sym
         default_root = File.expand_path(File.join(caller_file, '../../'))
       end
@@ -23,7 +23,7 @@ module Themeable
         #
         # @return [Symbol]
         def theme_name
-          @theme_name || raise("Theme name is no defined")
+          @theme_name || raise("Theme name can't be resolved from path: #{__FILE__}")
         end
 
         @root_path = #{default_root.inspect}
@@ -42,32 +42,6 @@ module Themeable
           @theme_path || 'theme'
         end
 
-        protected
-
-        # Set theme name
-        #
-        # @param [String, Symbol] theme_name
-        # @return [Symbol] symbolized theme_name
-        def set_theme_name(theme_name)
-          @theme_name = theme_name.to_sym
-        end
-
-        # Set root path of theme project
-        #
-        # @param [String] path
-        # @return [String]
-        def set_root_path(path)
-          @root_path = path
-        end
-
-        # Set theme's relative path, which path includes assets and views
-        #
-        # @param [String] path is a relative path where assets and views locate.
-        # @return [String]
-        def set_theme_path(path)
-          @theme_path = theme_path
-        end
-
       RUBY
     end
   end

data/lib/themeable/version.rb

@@ -1,3 +1,3 @@
 module Themeable
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/lib/themeable.rb

@@ -20,12 +20,12 @@ module Themeable
     themes.find{|t| t.theme_name == theme_name.to_sym } || raise("Theme #{theme_name} not found")
   end
 
-  def template_engine=(theme_name)
-    @template_engine = "theme_#{theme(theme_name).theme_name}"
+  def default_theme(theme_name)
+    @default_theme = "theme_#{theme(theme_name).theme_name}"
   end
 
-  def template_engine
-    @template_engine
+  def default_theme
+    @default_theme
   end
 
 end

data/templates/generators/copy_views_generator.rb

@@ -3,8 +3,15 @@ module Theme<%= theme_name.camelize %>
     class CopyViewsGenerator < Rails::Generators::Base
       source_root File.join(Theme<%= theme_name.camelize %>.root_path, 'theme')
       def copy_views
-        directory 'views', 'app/views'
-        directory 'scaffold_templates', 'lib/templates/theme_<%= theme_name %>/scaffold'
+        directory 'views', 'app/themes/<%= theme_name %>'
+
+        root = self.class.source_root
+        template_engine = Rails.application.config.app_generators.rails[:template_engine] || 'erb'
+        Dir.glob(File.join(root, "scaffold_templates/<%= theme_name %>/**/*.#{template_engine}")) do |file|
+          source_path = Pathname.new(file).relative_path_from(Pathname.new(root))
+          destination_path = Pathname.new(file).relative_path_from(Pathname.new(File.join(root, 'scaffold_templates/<%= theme_name %>')))
+          copy_file source_path, "lib/templates/#{template_engine}/scaffold/<%= theme_name %>/#{destination_path}"
+        end
       end
     end
   end

data/templates/theme_main.rb

@@ -3,7 +3,4 @@ require 'theme_<%= theme_name %>/version'
 
 module <%= app_name.camelize %>
   include Themeable::Theme
-  # set_name '<%= theme_name %>' # by default, resovle name by file path automatically
-  # set_root_path File.expand_path('../..', __FILE__)
-  # set_theme_path 'theme'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: themeable
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - xiaohui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-10 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -64,18 +64,17 @@ files:
 - README.md
 - Rakefile
 - bin/themeable
-- lib/generators/themeable/scaffold_admin_controller_generator.rb
 - lib/tasks/themeable_tasks.rake
 - lib/themeable.rb
 - lib/themeable/acts_as_themeable.rb
 - lib/themeable/command.rb
 - lib/themeable/css_path_resolver.rb
+- lib/themeable/generator_concern.rb
 - lib/themeable/railtie.rb
 - lib/themeable/theme.rb
 - lib/themeable/version.rb
 - templates/generators/copy_assets_generator.rb
 - templates/generators/copy_views_generator.rb
-- templates/generators/scaffold_generator.rb
 - templates/resolve_css_path.rake
 - templates/theme_main.rb
 - templates/view_application.html.erb

data/lib/generators/themeable/scaffold_admin_controller_generator.rb

@@ -1,17 +0,0 @@
-module Themeable
-  module Generators
-    class ScaffoldAdminControllerGenerator < Rails::Generators::NamedBase
-
-      def do_everything
-        return if @options.fetch('skip_scaffold_admin', false)
-        old_invocations = {}.merge(@_invocations)
-        @_invocations.clear
-        new_options = @options.merge('skip_scaffold_admin' => true, 'theme_template' => 'admin')
-        invoke :resource_route, ["admin/#{file_path}"]
-        invoke :scaffold_controller, ["admin/#{file_path}"], new_options
-        @_invocations.update(old_invocations)
-      end
-    end
-  end
-end
-

data/templates/generators/scaffold_generator.rb

@@ -1,30 +0,0 @@
-require 'rails/generators/erb/scaffold/scaffold_generator'
-
-module Theme<%= theme_name.camelize %>
-  module Generators
-    class ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
-      class_option :scaffold_template, type: :string, default: 'default',
-        desc: "Choose template to scaffold: default or admin"
-      source_root File.join(Theme<%= theme_name.camelize %>.root_path, "theme/scaffold_templates")
-
-      def copy_view_files
-        available_views.each do |view|
-          filename = filename_with_extensions view
-          template "#{options[:scaffold_template]}/#{view}.html.erb", File.join('app', 'views', controller_file_path, filename)
-        end
-      end
-
-      protected
-
-      def available_views
-        ['index', 'edit', 'show', 'new', '_form']
-      end
-
-      def handler
-        :erb
-      end
-
-    end
-  end
-end
-