themeable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fec3b1a194206c07f3ccdeb121f0648121c74cb
+  data.tar.gz: 77b948755c1d29ba790db5e273c06973beee019f
+SHA512:
+  metadata.gz: 124a1b09225454e062193d951b26f8ebeeb8e3c640064e0709b394bb5536b07408c6f330ef7d4f14af6cda93bb80956c268b2a757b35e9613331a555d891b068
+  data.tar.gz: 40b8d7fb90386c937670e3c6950d59857642e256e96182da7489d957727f6f99c67d916ceb799572909e367963e1a177fa362541f37e5f59c9d0447c351c7dfe

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 xiaohui
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Themeable
+
+You can create theme with this tool, make your Rails app choose theme dynamically.
+
+### Install gem
+
+    gem i themeable
+
+### Create my theme with command line
+
+    themeable new famous
+
+Now, directory `theme_famous` created with this tool.
+
+### Design my theme
+
+Start designing your theme in folder `theme`:
+
+    ├── theme
+    │   ├── assets
+    │   │   └── famous
+    │   │       ├── application.css
+    │   │       ├── application.js
+    │   │       └── vendor
+    │   └── views
+    │       └── layouts
+    │           └── application.html.erb
+
+### Use my theme in my Rails project
+
+Add gem to Rails app:
+
+    gem 'theme_famous', path: 'path_of_theme_famous'
+    
+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'
+      def index
+      end
+    end
+
+Or, you can make this controller use dynamic themes:
+
+    class HomeController < ApplicationController
+      acts_as_themeable :choose_theme
+      def index
+      end
+      
+      private
+      
+      def choose_theme
+        case params[:theme]
+        when 'famous' then 'famous'
+        when 'classic' then 'classic'
+        else; :none # :none means don't use theme
+        end
+      end
+    end

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Themeable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/tasks/themeable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :themeable do
+#   # Task goes here
+# end

data/lib/themeable/acts_as_themeable.rb

@@ -0,0 +1,28 @@
+module Themeable
+  module ActsAsThemeable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_themeable(theme_name)
+        instance_eval do
+          before_filter :insert_theme_view_path
+        end
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          private
+          def __themeable_theme_name
+            #{theme_name.is_a?(Symbol) ? "send(:#{theme_name})" : "'#{theme_name}'"}
+          end
+          def insert_theme_view_path
+            theme_name = __themeable_theme_name
+            return if theme_name == :none
+            view_paths = lookup_context.view_paths.to_a.map(&:to_path)
+            theme = Themeable.theme(__themeable_theme_name)
+            theme_view_path = File.join(theme.path, 'views')
+            lookup_context.view_paths = view_paths.insert(1, theme_view_path)
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/themeable/command.rb

@@ -0,0 +1,60 @@
+require 'thor'
+require 'active_support/core_ext/string'
+
+module Themeable
+  class Command < Thor
+    include Thor::Actions
+    source_root File.expand_path("../../../templates", __FILE__)
+
+    desc "help [COMMAND]", "View Usage"
+    def help(*args)
+      super(*args)
+    end
+
+    desc "new THEME_NAME", "Create a new theme"
+    def new(name)
+      @theme_name = name
+      @app_name = "theme_#{name}"
+      say('Initializing theme project...', :green)
+      # say("\"rails plugin new #{app_name} -T\"")
+      system "rails plugin new #{app_name} -T"
+
+      @destination_stack ||= []
+      @destination_stack[0] = File.expand_path(app_name)
+
+      gsub_file "#{app_name}.gemspec", /TODO[: ]*/, ''
+
+      insert_into_file "#{app_name}.gemspec", after: %r{^ *s\.add_dependency .*} do
+        "\n  s.add_dependency 'themeable'"
+      end
+
+      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"
+
+      create_file "theme/assets/#{theme_name}/vendor/.gitkeep"
+      create_file "theme/assets/#{theme_name}/application.css"
+      create_file "theme/assets/#{theme_name}/application.js"
+      create_file "theme/views/layouts/.gitkeep"
+      template "view_application.html.erb", "theme/views/layouts/application.html.erb"
+
+      remove_file "lib/#{app_name}.rb"
+      template 'theme_main.rb', "lib/#{app_name}.rb"
+
+      puts
+      say("Done. Please check your new theme project in directory #{app_name}", :green)
+      puts
+    end
+
+    no_tasks do
+      def app_name
+        @app_name
+      end
+      def theme_name
+        @theme_name
+      end
+      def set_destination_root(name)
+        destination_root = name
+      end
+    end
+  end
+end

data/lib/themeable/railtie.rb

@@ -0,0 +1,16 @@
+require 'rails'
+module Themeable
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      ActionController::Base.send :include, Themeable::ActsAsThemeable
+    end
+    initializer :themeable do
+      # puts "== Themeable =="
+      Themeable.themes.each do |theme|
+        config.assets.paths << File.join(theme.path, 'assets')
+        config.assets.precompile << /\A#{Regexp.escape(theme.name)}\/[^\/]+\.(js|css)\z/
+        config.assets.precompile << /\A#{Regexp.escape(theme.name)}\/.+\.(gif|jpg|png|svg)\z/
+      end
+    end
+  end
+end

data/lib/themeable/theme.rb

@@ -0,0 +1,30 @@
+module Themeable
+  module Theme
+    def self.included(subclass)
+      Themeable.add_theme(subclass)
+      subclass.instance_eval <<-'RUBY'
+        
+        @name = nil
+        def name
+          @name || raise("Theme name is no defined")
+        end
+
+        @path = nil
+        def path
+          @path || raise("Theme path is no defined")
+        end
+
+        private
+
+        def set_name(name)
+          @name = name.to_sym
+        end
+
+        def set_path(path)
+          @path = path
+        end
+
+      RUBY
+    end
+  end
+end

data/lib/themeable/version.rb

@@ -0,0 +1,3 @@
+module Themeable
+  VERSION = "1.0.0"
+end

data/lib/themeable.rb

@@ -0,0 +1,21 @@
+require 'themeable/version'
+require 'themeable/railtie'
+require 'themeable/theme'
+require 'themeable/acts_as_themeable'
+
+module Themeable
+
+  @@theme_set = Set.new
+  def self.add_theme(theme_class)
+    @@theme_set << theme_class
+  end
+
+  def self.themes
+    @@theme_set
+  end
+
+  def self.theme(theme_name)
+    themes.find{|t| t.name == theme_name.to_sym } || raise("Theme #{theme_name} not found")
+  end
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: themeable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- xiaohui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Creating theme, and puting into your Rails app
+email:
+- xiaohui@zhangxh.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/themeable_tasks.rake
+- lib/themeable.rb
+- lib/themeable/acts_as_themeable.rb
+- lib/themeable/command.rb
+- lib/themeable/railtie.rb
+- lib/themeable/theme.rb
+- lib/themeable/version.rb
+homepage: https://github.com/xiaohui-zhangxh/
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A tool for creating theme.
+test_files: []