themeable 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 226dd22ad75dcbfb96aa75860a0c8cb733cedfec
-  data.tar.gz: 9dc9079e67e956c5486543615891f0ab19cc6ffb
+  metadata.gz: 5c2c88465cfcd7a507c2f118801ad8b5f707e568
+  data.tar.gz: ec2e1826e7d404f8b3286fe9f1716255fe4e18b9
 SHA512:
-  metadata.gz: 33dffd44dd810e344ed29ec70625221a950588f341da2054950aea59e9ec1094e966011bffe221e2c49be4db32b3524141a74d3d417ee110811e946c8fe73b2d
-  data.tar.gz: d2ffc2a5423dacc228742ba9f8bea34548242aeba590bcc7efb93277a4ae6f71d1a1db5c4235cbc6e0b5592bf8715df387dfc5fb8120979d5a69af9f3d90e83c
+  metadata.gz: 9dbd7f95f31a7c182ba13214eb6658374ece3a4765922801d7efae104b876577ce5bfa98bf0ed05524646ea90d3f8931ed664b817329328de06a2cd04795c134
+  data.tar.gz: 98f9b7da433ffdd4e7ff6c97336e9433e4c8ef30f3676f7562ffea1ee20a60c9b39613fdf1f89b356e1994762310386c67ecd2b365a9d0baa7b81798f9b5a984

data/README.md

@@ -6,38 +6,70 @@ You can create theme with this tool, make your Rails app choose theme dynamicall
 
     gem i themeable
 
-### Create my theme with command line
+### Create your theme with command line
 
-    themeable new famous
+    themeable new my_theme
 
-Now, directory `theme_famous` created with this tool.
+Now, directory `theme_my_theme` created with this tool.
 
-### Design my theme
+### Design your theme
 
 Start designing your theme in folder `theme`:
 
-    ├── theme
-    │   ├── assets
-    │   │   └── famous
-    │   │       ├── application.css
-    │   │       ├── application.js
-    │   │       └── vendor
-    │   └── views
-    │       └── layouts
-    │           └── application.html.erb
+    theme
+    ├── assets
+    │   └── my_theme
+    │       ├── application.css
+    │       └── application.js
+    ├── scaffold_templates
+    │   ├── admin
+    │   │   ├── _form.html.erb
+    │   │   ├── edit.html.erb
+    │   │   ├── index.html.erb
+    │   │   ├── new.html.erb
+    │   │   └── show.html.erb
+    │   └── default
+    │       ├── _form.html.erb
+    │       ├── edit.html.erb
+    │       ├── index.html.erb
+    │       ├── new.html.erb
+    │       └── show.html.erb
+    └── views
+        └── layouts
+            └── application.html.erb
 
-### Use my theme in my Rails project
+- 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/views: your views
+
+
+If you have some vendor scripts and stylesheets, please put them in vendor/my_theme:
+
+    vendor
+    └── my_theme
+
+To require vendor files, do it as this:
+
+# in some.js
+
+    //= require my_theme/xxx/xxx
+
+# in some.css
+
+    *= require my_theme/xxx/xxx
+
+### Use your theme in your Rails project
 
 Add gem to Rails app:
 
-    gem 'theme_famous', path: 'path_of_theme_famous'
+    gem 'theme_my_theme', path: 'path_of_theme_my_theme'
     
 Use theme in controller:
 
 By default you need to remove `views/layouts/application.html.erb` from Rails app, make sure Rails can use theme's layout.
 
     class HomeController < ApplicationController
-      acts_as_themeable 'famous'
+      acts_as_themeable 'my_theme'
       def index
       end
     end
@@ -53,9 +85,82 @@ Or, you can make this controller use dynamic themes:
       
       def choose_theme
         case params[:theme]
-        when 'famous' then 'famous'
+        when 'my_theme' then 'my_theme'
         when 'classic' then 'classic'
         else; :none # :none means don't use theme
         end
       end
-    end
+    end
+
+### Use `theme_my_theme` as template engine to scaffold controller views
+
+    $ rails g scaffold_controller User --template-engine=theme_my_theme --scaffold-template=default
+      
+        create  app/controllers/users_controller.rb
+        invoke  theme_my_theme
+        create    app/views/users
+        create    app/views/users/index.html.erb
+        create    app/views/users/edit.html.erb
+        create    app/views/users/show.html.erb
+        create    app/views/users/new.html.erb
+        create    app/views/users/_form.html.erb
+        invoke  test_unit
+        create    test/controllers/users_controller_test.rb
+        invoke  helper
+        create    app/helpers/users_helper.rb
+        invoke    test_unit
+        invoke  jbuilder
+        create    app/views/users/index.json.jbuilder
+        create    app/views/users/show.json.jbuilder
+        create    app/views/users/_user.json.jbuilder
+
+### 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:
+
+    $ rails g theme_my_theme:copy_assets
+    
+         exist  app/assets/themes
+        create  app/assets/themes/my_theme/application.css
+        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`
+
+    module TestTheme
+      class Application < Rails::Application
+
+        ....
+
+        Themeable.template_engine = :my_theme
+
+        ...
+
+      end
+    end
+
+
+
+    
+

data/lib/generators/themeable/scaffold_admin_controller_generator.rb

@@ -0,0 +1,17 @@
+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/lib/themeable/command.rb

@@ -17,7 +17,7 @@ module Themeable
       @app_name = "theme_#{name}"
       say('Initializing theme project...', :green)
       # say("\"rails plugin new #{app_name} -T\"")
-      system "rails plugin new #{app_name} -T"
+      system "rails plugin new #{app_name} -T -B"
 
       @destination_stack ||= []
       @destination_stack[0] = File.expand_path(app_name)
@@ -32,8 +32,9 @@ module Themeable
       end
 
       # generators
-      template 'theme_views_generator.rb', "lib/generators/themeable/#{theme_name}/views_generator.rb"
-      template 'theme_assets_generator.rb', "lib/generators/themeable/#{theme_name}/assets_generator.rb"
+      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"
 
       # assets and views
       create_file "theme/assets/#{theme_name}/application.css"
@@ -41,6 +42,15 @@ module Themeable
       create_file "theme/views/layouts/.gitkeep"
       template "view_application.html.erb", "theme/views/layouts/application.html.erb"
 
+      # 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"
+      end
+
       # vender files
       create_file "vendor/#{theme_name}/.gitkeep"
 

data/lib/themeable/railtie.rb

@@ -1,16 +1,25 @@
 require 'rails'
 module Themeable
   class Railtie < Rails::Railtie
+
     config.to_prepare do
       ActionController::Base.send :include, Themeable::ActsAsThemeable
     end
+
     initializer :themeable do
+      config.app_generators.template_engine Themeable.template_engine if Themeable.template_engine
       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.name)}\/[^\/]+\.(js|css)\z/
-        config.assets.precompile << /\A#{Regexp.escape(theme.name)}\/.+\.(gif|jpg|png|svg)\z/
+        config.assets.precompile << /\A#{Regexp.escape(theme.theme_name)}\/[^\/]+\.(js|css)\z/
+        config.assets.precompile << /\A#{Regexp.escape(theme.theme_name)}\/.+\.(gif|jpg|png|svg)\z/
       end
     end
+
+    generators do |app|
+      Rails::Generators::ScaffoldControllerGenerator.class_option :scaffold_template, default: 'default', desc: 'Which scaffold template of themeable plugin you want to use'
+    end
+
   end
 end
+

data/lib/themeable/theme.rb

@@ -1,7 +1,7 @@
 module Themeable
 
   # Theme's basic module, automatically define methods
-  #   - name
+  #   - theme_name
   #   - root_path
   #   - theme_path
   module Theme
@@ -12,18 +12,18 @@ module Themeable
       # set default values
       caller_file = caller.first
       if caller_file =~ %r{/theme_(.+?)/lib/theme_\1\.rb}
-        default_name = $1.to_sym
+        default_theme_name = $1.to_sym
         default_root = File.expand_path(File.join(caller_file, '../../'))
       end
 
       subclass.instance_eval <<-RUBY, __FILE__, __LINE__ + 1
-        @name = #{default_name.inspect}
+        @theme_name = #{default_theme_name.inspect}
 
         # Theme name
         #
         # @return [Symbol]
-        def name
-          @name || raise("Theme name is no defined")
+        def theme_name
+          @theme_name || raise("Theme name is no defined")
         end
 
         @root_path = #{default_root.inspect}
@@ -46,10 +46,10 @@ module Themeable
 
         # Set theme name
         #
-        # @param [String] name
-        # @return [Symbol] symbolized name
-        def set_name(name)
-          @name = name.to_sym
+        # @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

data/lib/themeable/version.rb

@@ -1,3 +1,3 @@
 module Themeable
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/themeable.rb

@@ -5,17 +5,27 @@ require 'themeable/acts_as_themeable'
 
 module Themeable
 
+  module_function
+
   @@theme_set = Set.new
-  def self.add_theme(theme_class)
+  def add_theme(theme_class)
     @@theme_set << theme_class
   end
 
-  def self.themes
+  def themes
     @@theme_set
   end
 
-  def self.theme(theme_name)
-    themes.find{|t| t.name == theme_name.to_sym } || raise("Theme #{theme_name} not found")
+  def theme(theme_name)
+    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}"
+  end
+
+  def template_engine
+    @template_engine
   end
 
 end

data/templates/generators/copy_assets_generator.rb

@@ -0,0 +1,11 @@
+module Theme<%= theme_name.camelize %>
+  module Generators
+    class CopyAssetsGenerator < Rails::Generators::Base
+      source_root File.join(Theme<%= theme_name.camelize %>.root_path, 'theme')
+      def copy_assets
+        directory 'assets', 'app/assets/themes'
+      end
+    end
+  end
+end
+

data/templates/generators/copy_views_generator.rb

@@ -0,0 +1,12 @@
+module Theme<%= theme_name.camelize %>
+  module Generators
+    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'
+      end
+    end
+  end
+end
+

data/templates/generators/scaffold_generator.rb

@@ -0,0 +1,30 @@
+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
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: themeable
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - xiaohui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -64,6 +64,7 @@ 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
@@ -71,9 +72,10 @@ files:
 - lib/themeable/railtie.rb
 - lib/themeable/theme.rb
 - lib/themeable/version.rb
-- templates/theme_assets_generator.rb
+- templates/generators/copy_assets_generator.rb
+- templates/generators/copy_views_generator.rb
+- templates/generators/scaffold_generator.rb
 - templates/theme_main.rb
-- templates/theme_views_generator.rb
 - templates/view_application.html.erb
 homepage: https://github.com/xiaohui-zhangxh/
 licenses:

data/templates/theme_assets_generator.rb

@@ -1,10 +0,0 @@
-module Themeable
-  module <%= theme_name.camelize %>
-    class AssetsGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../../../../theme", __FILE__)
-      def copy_assets
-        directory 'assets', 'app/assets/themes'
-      end
-    end
-  end
-end

data/templates/theme_views_generator.rb

@@ -1,10 +0,0 @@
-module Themeable
-  module <%= theme_name.camelize %>
-    class ViewsGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../../../../theme", __FILE__)
-      def copy_views
-        directory 'views', 'app/views'
-      end
-    end
-  end
-end