RubyGems - shiny_themes - Versions diffs - 0.0.1 - Mend

shiny_themes 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (65) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/Rakefile +34 -0
data/lib/generators/shiny_themes/install_generator.rb +19 -0
data/lib/generators/shiny_themes/templates/application.html.erb +14 -0
data/lib/generators/shiny_themes/templates/manifest.css +14 -0
data/lib/generators/shiny_themes/templates/manifest.js +9 -0
data/lib/generators/shiny_themes/templates/manifest.scss +12 -0
data/lib/generators/shiny_themes/templates/theme.yml +8 -0
data/lib/generators/shiny_themes/theme_generator.rb +50 -0
data/lib/shiny_themes.rb +8 -0
data/lib/shiny_themes/engine.rb +56 -0
data/lib/shiny_themes/renders_theme.rb +53 -0
data/lib/shiny_themes/theme.rb +76 -0
data/lib/shiny_themes/theme_config.rb +45 -0
data/lib/shiny_themes/version.rb +3 -0
data/test/dummy/README.rdoc +28 -0
data/test/dummy/Rakefile +6 -0
data/test/dummy/app/assets/javascripts/application.js +13 -0
data/test/dummy/app/assets/stylesheets/application.css +15 -0
data/test/dummy/app/controllers/application_controller.rb +5 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/themes/test_theme/views/layouts/test_layout.html.erb +14 -0
data/test/dummy/app/themes/test_theme/views/shiny_themes/test/test.html.erb +1 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/bin/bundle +3 -0
data/test/dummy/bin/rails +4 -0
data/test/dummy/bin/rake +4 -0
data/test/dummy/bin/setup +29 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +29 -0
data/test/dummy/config/boot.rb +5 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +38 -0
data/test/dummy/config/environments/production.rb +76 -0
data/test/dummy/config/environments/test.rb +42 -0
data/test/dummy/config/initializers/assets.rb +11 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/cookies_serializer.rb +3 -0
data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/test/dummy/config/initializers/inflections.rb +16 -0
data/test/dummy/config/initializers/mime_types.rb +4 -0
data/test/dummy/config/initializers/session_store.rb +3 -0
data/test/dummy/config/initializers/wrap_parameters.rb +9 -0
data/test/dummy/config/locales/en.yml +23 -0
data/test/dummy/config/routes.rb +56 -0
data/test/dummy/config/secrets.yml +22 -0
data/test/dummy/config/theme.yml +4 -0
data/test/dummy/log/test.log +11146 -0
data/test/dummy/public/404.html +67 -0
data/test/dummy/public/422.html +67 -0
data/test/dummy/public/500.html +66 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/tmp/app/themes/temp_theme/assets/javascripts/temp_theme/manifest.js +9 -0
data/test/dummy/tmp/app/themes/temp_theme/assets/stylesheets/temp_theme/manifest.css +14 -0
data/test/dummy/tmp/app/themes/temp_theme/views/layouts/temp_layout.html.erb +14 -0
data/test/generators/shiny_themes/install_generator_test.rb +23 -0
data/test/generators/shiny_themes/theme_generator_test.rb +59 -0
data/test/lib/engine_test.rb +73 -0
data/test/lib/renders_theme_test.rb +72 -0
data/test/lib/theme_config_test.rb +60 -0
data/test/lib/theme_test.rb +115 -0
data/test/support/theme_test_helper.rb +23 -0
data/test/test_helper.rb +19 -0
metadata +169 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b00177d3c7213ebd42c0b4b3ed3b24319cb5c0b7
+  data.tar.gz: 0f8f7d64c1c48e74c01bc6345d20853f4e976f42
+SHA512:
+  metadata.gz: f69b5ea0cc66fbd109b4e523f15c987ca7d715690a7616d776f89fc44c28639306ab76aa9d782e498dc8d2c2ad1204ad51af49d21be477a580b7157de40f6bbc
+  data.tar.gz: 6021d0920150c6d268e58f66a7c4deb66e58a0bac6f5e94fb8386f5af8337433aa25dd9e071d145e1af1367a2d623ea2ddc4ddd852de86b970f3eb52f105dfc3

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2016 shinylane
+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/Rakefile ADDED Viewed

@@ -0,0 +1,34 @@
+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    = 'ShinyThemes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+Bundler::GemHelper.install_tasks
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task default: :test

data/lib/generators/shiny_themes/install_generator.rb ADDED Viewed

@@ -0,0 +1,19 @@
+require 'rails/generators'
+module ShinyThemes
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      # Create default configuration file in config directory
+      def copy_config_file
+        copy_file "theme.yml", "config/theme.yml"
+      end
+      # Create the default themes directory under app
+      def create_themes_directory
+        empty_directory File.join("app", "themes")
+      end
+    end
+  end
+end

data/lib/generators/shiny_themes/templates/application.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= theme_name %></title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/lib/generators/shiny_themes/templates/manifest.css ADDED Viewed

@@ -0,0 +1,14 @@
+/* manifest stylesheet
+* Use this to import all stylesheets for your theme.  If you want to
+* import stylesheets in different pages or layouts simply create another
+* manifest file and begin the name with 'manifest_' or 'manifest-'
+*
+* The CSS extension manifests will use require comments that sprockets
+* uses to import stylesheets.  Generate a sass theme to use the sass
+* import syntax.
+*
+* Require this stylesheet
+*=require_self
+* Require all stylesheets in the current directory
+*=require_tree .
+*/

data/lib/generators/shiny_themes/templates/manifest.js ADDED Viewed

@@ -0,0 +1,9 @@
+/* Manifest javascript
+*  Use this to import all javascripts for your theme.  If you want to
+*  import javascript files in different pages or layouts simply create
+*  another manifest file and begin the name with 'manifest_' or 'manifest-'
+ */
+// Require this JS file
+//=require_self
+// Require all javascripts in the current directory
+//=require_tree .

data/lib/generators/shiny_themes/templates/manifest.scss ADDED Viewed

@@ -0,0 +1,12 @@
+/* manifest stylesheet
+* Use this to import all stylesheets for your theme.  If you want to
+* import stylesheets in different pages or layouts simply create another
+* manifest file and begin the name with 'manifest_' or 'manifest-'
+*
+* The scss extension uses sass import syntax to import stylesheets. If
+* you want to use the sprockets require comment syntax create a manifest
+* file with a .css extension (or rename this one).
+*/
+/* Require all stylesheets in the current directory*/
+@import "*/**";

data/lib/generators/shiny_themes/templates/theme.yml ADDED Viewed

@@ -0,0 +1,8 @@
+---
+development: &development
+  name: 'default'
+  layout: 'application'
+test:
+  <<: *development
+production:
+  <<: *development

data/lib/generators/shiny_themes/theme_generator.rb ADDED Viewed

@@ -0,0 +1,50 @@
+require 'rails/generators'
+module ShinyThemes
+  module Generators
+    class ThemeGenerator < Rails::Generators::NamedBase
+      desc            "This generator creates a new theme using the provided name and options"
+      source_root     File.expand_path("../templates", __FILE__)
+      argument        :name, type: :string
+      class_option   :layout, type: :string, aliases: '-l', default: 'application', desc: 'Default layout for theme rendering'
+      class_option   :sass, type: :boolean, aliasses: '-s', default: false, desc: 'Use sass for stylesheets'
+      def initialize(args, *options)
+        super
+        @theme_directory = Pathname(Rails.application.config.theme.path).join(name)
+        @views_directory = @theme_directory.join('views')
+        @assets_directory = @theme_directory.join('assets')
+      end
+      def create_theme_directories
+        # Create views directories
+        empty_directory @views_directory.join('layouts')
+        # Create Assets directories
+        empty_directory @assets_directory.join('images', name)
+        create_file     @assets_directory.join('images', name, '.gitkeep'), nil
+        empty_directory @assets_directory.join('javascripts', name)
+        create_file     @assets_directory.join('javascripts', name, '.gitkeep'), nil
+        empty_directory @assets_directory.join('stylesheets', name)
+        create_file     @assets_directory.join('stylesheets', name, '.gitkeep'), nil
+      end
+      def create_js_files
+        copy_file 'manifest.js', "#{@assets_directory.join('javascripts', name, 'manifest.js')}"
+      end
+      def create_css_files
+        return if options[:sass]
+        copy_file 'manifest.css', "#{@assets_directory.join('stylesheets', name, 'manifest.css')}"
+      end
+      def create_sass_files
+        return unless options[:sass]
+        copy_file 'manifest.scss', "#{@assets_directory.join('stylesheets', name, 'manifest.scss')}"
+      end
+      def create_layout_file
+        copy_file 'application.html.erb', "#{@views_directory.join('layouts', "#{options[:layout]}.html.erb")}"
+      end
+    end
+  end
+end

data/lib/shiny_themes.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'active_model'
+require 'active_support/concern'
+require 'shiny_themes/engine'
+module ShinyThemes
+  autoload :Theme, 'shiny_themes/theme'
+  autoload :RendersTheme, 'shiny_themes/renders_theme'
+end

data/lib/shiny_themes/engine.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require 'shiny_themes/theme_config'
+module ShinyThemes
+  # Engine defines configuration and populates from the theme.yml config file.
+  # The class also updates the asset pipeline to include theme directories and files
+  # as well as including the RendersTheme module in ActionController::Base.
+  class Engine < ::Rails::Engine
+    # Class methods to help manage the rails config and the associated YAML file.
+    class << self
+      def theme_config
+        @theme_config ||= ShinyThemes::ThemeConfig.new
+      end
+      def default_options
+        { path: File.join('app', 'themes'),
+          asset_directories: %w(images stylesheets javascripts) }
+      end
+    end
+    initializer 'shiny_themes.theme_config' do |_|
+      Engine.theme_config.load
+    end
+    initializer 'shiny_themes.assets_path' do |app|
+      Dir.glob(Rails.root.join(app.config.theme.path, '*', 'assets', '**', '*')) do |dir|
+        # Add all themes directories and sub-directories to asset pipeline which
+        # makes it necessary to restart the application on theme installation
+        app.config.assets.paths << dir if Pathname(dir).directory?
+      end
+    end
+    initializer 'shiny_themes.precompile_assets' do |app|
+      app.config.assets.precompile << Proc.new do |path, filename|
+        # Precompile if the asset is under the themes directory and is either an
+        # image a manifest file or a non css/js asset.
+        if path =~ /#{app.config.theme.path}/
+          if !%w(.js .css).include?(File.extname(filename))
+            true
+          elsif path =~ /^[^\/]+\/manifest((_|-).+)?\.(js|css)$/ # named or starts with manifest
+            true
+          else
+            false
+          end
+        end
+      end
+    end
+    initializer 'shiny_themes.application_controller' do |_|
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.class_eval do
+          include RendersTheme
+        end
+      end
+    end
+  end
+end

data/lib/shiny_themes/renders_theme.rb ADDED Viewed

@@ -0,0 +1,53 @@
+module ShinyThemes
+  # RendersTheme concern
+  # Included into ActionController::Base providing a theme class variable for controllers.
+  # This theme defines a view path for templates and a layout to render with.
+  module RendersTheme
+    extend ActiveSupport::Concern
+    included do
+      cattr_accessor :theme
+      # Create a new theme which will use Rails.application.config.theme settings
+      self.theme = Theme.new
+      layout Proc.new { |controller| controller.class.theme.layout }
+      prepend_before_action do |controller|
+        controller.prepend_view_path controller.class.theme.views_path
+      end
+    end
+    # @return [String] the current theme name
+    def current_theme_name
+      self.class.theme.name
+    end
+    # @return [String] the current theme default layout
+    def current_theme_layout
+      self.class.theme.layout
+    end
+    # Update the current theme for the controller and optionally save
+    # @param name [String] The name of the new theme
+    # @param options [Hash] Options hash
+    # @option options [String] :layout ('application') Default layout for theme
+    # @option options [Boolean] :dont_save (false) Dont save the update to the theme.yml config
+    # @return (Theme) the theme for the controller
+    def update_current_theme(name, options = {})
+      self.class.renders_theme(name, options)
+      Rails.application.config.theme.name = current_theme_name
+      Rails.application.config.theme.layout = current_theme_layout
+      ShinyThemes::Engine.theme_config.save unless options[:dont_save]
+      self.class.theme # return current theme object
+    end
+    module ClassMethods
+      # Use the theme and options for all rendering in this controller
+      # @param name [String] the name of the new theme
+      # @param options [Hash] Options hash
+      # option options [String] :layout ('application') Default layout for theme
+      # @return (Theme) the theme for the controller
+      def renders_theme(name, options = {})
+        self.theme = Theme.new(options.merge(name: name, layout: options[:layout]))
+      end
+    end
+  end
+end

data/lib/shiny_themes/theme.rb ADDED Viewed

@@ -0,0 +1,76 @@
+module ShinyThemes
+  # Theme model class which is meant to be associated with one or more
+  # controllers.  This theme "contains" assets (css, js, etc) as well as any
+  # views the them overrides and/or defines.
+  class Theme
+    include ActiveModel::Validations
+    # @return [String] the name of the theme which must match the root directory
+    #   name where theme files are located.  Defaults to config.theme.name value
+    attr_reader :name
+    # @return [String]] the name of the default layout to use.  Defaults to
+    #   config.theme.layout or 'application' if this does not exist
+    attr_accessor :layout
+    validates_presence_of :name, :layout
+    # 'views' directory must exist in the theme directory 'name/views' where
+    #   name is the theme name
+    validate :views_directory_exists
+    # 'assets' directory must exist in the theme directory 'name/assets' where
+    #   name is the theme name
+    validate :assets_directory_exists
+    # all Rails.application.config.theme.asset_directories must exist under
+    # 'name/assets' and must have a namespaced directory that shares the name of
+    # the theme.  For example the images directory should look like -
+    # 'name/assets/images/name' where name is the theme name.
+    validate do |theme|
+      Rails.application.config.theme.asset_directories.each do |directory|
+        unless theme.asset_path.join(directory).exist? &&
+            theme.asset_path.join(directory, name).exist?
+          theme.errors.add(:base, "Missing or invalid #{directory} asset directory for theme")
+        end
+      end
+    end
+    # @param options [Hash] initialization options
+    # @option options [String] :name (Rails.application.config.theme.name) The 1
+    #   name of the theme.
+    # @option options [String] :layout (Rails.application.config.theme.layout ||
+    #   'application') The name of the default layout.
+    # @option options [String] : :theme_path (Rails.application.config.theme.path)
+    #   The path to the theme's parent directory.
+    def initialize(options = {})
+      @name = options[:name] || Rails.application.config.theme.name
+      @layout = options[:layout] || Rails.application.config.theme.layout || 'application'
+      @theme_path = options[:theme_path] || Rails.application.config.theme.path
+    end
+    # @return [Pathname] Path to the theme's root directory
+    def path
+      Rails.root.join(@theme_path, @name)
+    end
+    # @return [Pathname] Path to the theme's view directory
+    def views_path
+      path.join('views')
+    end
+    # @return [Pathname] Path to the theme's assets directory
+    def asset_path
+      path.join('assets')
+    end
+    protected
+      def views_directory_exists
+        unless views_path.exist? && views_path.directory?
+          errors.add(:base, "Missing theme views directory")
+        end
+      end
+      def assets_directory_exists
+        unless asset_path.exist? && asset_path.directory?
+          errors.add(:base, "Missing theme assets directory")
+        end
+      end
+  end
+end

data/lib/shiny_themes/theme_config.rb ADDED Viewed

@@ -0,0 +1,45 @@
+module ShinyThemes
+  class ThemeConfig
+    attr_accessor :defaults
+    # Create the ordered options, populate with provided hash and load YAML file
+    # options.
+    # @param default_options [Hash] (Hash.new) - Options to populate the theme
+    #   config with.
+    # @options default_options [String] :path The path relative to the rails root
+    #   where templates are installed
+    # @options default_options [Array(String)] :asset_directories Names of
+    #   directories containing assets for the theme relative to the 'assets'
+    #   directory.
+    def initialize(defaults = Engine.default_options)
+      unless Rails.application.config.try(:theme)
+        Rails.application.config.theme = ActiveSupport::OrderedOptions.new
+      end
+      @defaults = defaults
+    end
+    # Load the theme.yml file and merge it with the theme configuration
+    def load
+      new_config = full_config[Rails.env].deep_symbolize_keys!
+      # Honor values in config file over defaults
+      @defaults.reject! { |k, _| new_config.keys.include?(k) }
+      Rails.application.config.theme.merge!(@defaults.merge(new_config))
+    end
+    # Save the current state of the theme config to the theme.yml file
+    def save
+      # Don't save default values
+      save_config = Rails.application.config.theme.reject { |k, _| @defaults.keys.include?(k) }
+      full_config[Rails.env].merge!(save_config)
+      File.open(config_pathname, 'w') { |f| f << full_config.to_yaml }
+    end
+    # The pathname where the theme config file can be found
+    def config_pathname
+      Rails.root.join('config', 'theme.yml')
+    end
+    def full_config
+      @full_config ||= YAML.load(File.open(config_pathname))
+    end
+  end
+end