roger_themes 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 343f6ba8dd1ada47ce7f807e7f75d0d2eb967290
-  data.tar.gz: 3eebe8c2dffb2d66371860a956a73d449083a0e0
+  metadata.gz: 76fc57d42183dffca4cd97846cdf5874e3fd849d
+  data.tar.gz: bbd6603a9c732670c0351b13edc29bdc05574735
 SHA512:
-  metadata.gz: 6b17333d87abb55c611d3b4c0654b9def8720a7ea1e89aad35c8a182a4b509daa3a4651232a7dfc162f3ec299303b3044e88180708d6ae9d09b93a2d4b3d5978
-  data.tar.gz: 1971ad918be63c83e1aa7ac6e46cd3c265e986e19d6925243419dfc0cb1f69e28cfb8c3d0e357cab7cbe0c5684e9e22b385d73e59a20af8d2d069d751ec8313b
+  metadata.gz: e5d6460310efd4822829c96890f1c9275f064957307e2b1d74dad16e96d3a50517673d2fa5021f19629af914e3decbc1ac8ee02de200cb0f72e4dad490bc8c45
+  data.tar.gz: d0dd0779c0796010a7478050b2802e480693e35e730e771cb988ff171f2bbfc0e36d2d5aa4740b097cdfc29804a798cb3ad6c6dd709cbe2ba8355ff3a6a33743

data/README.md

@@ -48,6 +48,12 @@ mockup.release do |r|
 
 ## Changelog
 
+### v0.6.0
+* Attention! `env["SITE_THEME"]` has been renamed to `env["MAIN_THEME"]`. Also it will now return a `RogerThemes::Theme` object instead of a string. The old behaviour can be restored by replacing `env["SITE_THEME"]` with `env["MAIN_THEME"].name`
+* Add compatibility for subthemes
+* Add support for manifest files
+* Add datastructures for themes and assets
+
 ### v0.5.0
 * Make compatible with Roger 1.7
 

data/lib/roger_themes.rb

@@ -4,9 +4,21 @@ require "fileutils"
 include FileUtils
 
 module RogerThemes
-  # Your code goes here...
+
+  # The path within the project.html_path
+  def self.themes_path=(path)
+    @themes_path = path.to_s.sub(/\A\//, "")
+  end
+
+  def self.themes_path
+    @themes_path || "themes"
+  end
+
 end
 
+require "roger_themes/manifest"
+require "roger_themes/asset"
+require "roger_themes/theme"
 require "roger_themes/middleware"
 require "roger_themes/processor"
 require "roger_themes/xc_finalizer"

data/lib/roger_themes/asset.rb

@@ -0,0 +1,44 @@
+module RogerThemes
+  class Asset
+    attr_reader :theme, :data
+
+    def initialize(data, theme)
+      @data = {}
+      update(data)
+      @theme = theme
+    end
+
+    def update(data)
+      @data.update(data)
+    end
+
+    def initialize_copy(source)
+      @data = @data.dup
+    end
+
+    # Relative path within theme
+    def path
+      @data["path"].to_s
+    end
+
+    def full_path
+      theme.path + path
+    end
+
+    def url
+      [theme.url.sub(/\/\Z/, ''), path.sub(/\A\//, '')].join("/")
+    end
+
+    def location
+      @data["location"].to_s
+    end
+
+    def type
+      @data["type"].to_s
+    end
+
+    def attributes
+      @data["attributes"] || {}
+    end
+  end
+end

data/lib/roger_themes/manifest.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+
+module RogerThemes
+  class Manifest
+
+    DEFAULTS = {
+      title: nil,
+      type: "main",
+      mains: nil,
+      assets: []
+    }
+
+    def initialize(theme)
+      manifest_path = theme.path + "manifest.yml"
+
+      @data = {}.update(DEFAULTS)
+
+      if File.exist?(manifest_path)
+        data = YAML.load_file(manifest_path)
+        data.each do |k,v|
+          @data[k.to_sym] = v
+        end
+      end
+
+      # Make sure we have a title
+      @data[:title] ||= theme.name
+    end
+
+    def [](name)
+      @data[name]
+    end
+
+  end
+end

data/lib/roger_themes/middleware.rb

@@ -17,15 +17,23 @@ module RogerThemes
     end
 
     def call(env)
+      project = env["roger.project"] || self.project # self.project is for tests.
+      themes_path = project.html_path + RogerThemes.themes_path
+
       path = ::Rack::Utils.unescape(env["PATH_INFO"])
-      r = /\A\/themes\/([^\/]+)\/theme\//
+      r = /\A\/#{Regexp.escape(RogerThemes.themes_path)}\/([^\/]+)\/theme\//
+
+      env["SUB_THEME"] = nil
+
       if theme = path[r,1]
+        main_theme, sub_theme = theme.split(".", 2)
         orig_path = env["PATH_INFO"].dup
-        env["SITE_THEME"] = theme
+        env["MAIN_THEME"] = Theme.new(main_theme, themes_path)
+        env["SUB_THEME"] = Theme.new(sub_theme, themes_path) if sub_theme
         env["PATH_INFO"].sub!(r,"")
       else
         # Set default theme
-        env["SITE_THEME"] = @options[:default_theme]
+        env["MAIN_THEME"] = Theme.new(@options[:default_theme], themes_path)
       end
 
       ret = @app.call(env)

data/lib/roger_themes/processor.rb

@@ -3,85 +3,86 @@ require "roger/release/processors/mockup"
 
 module RogerThemes
   class Processor < Roger::Release::Processors::Base
-    def initialize(options = {})
+    self.name = :roger_themes
 
-      defaults = {
+    def default_options
+      {
         default_theme: 'default',
         excludes: [
           /\A_doc\/.*/,
           /\Athemes\/.*/,
           "index.html"
         ],
-        shared_folders: ["images", "fonts"]
+        shared_folders: ["images", "fonts"],
+        template_glob: "**/*{.html,.html.erb}"
       }
-
-      @options = defaults.update(options)
     end
 
-    def call(release, options = {})
-      @options = @options.dup.update(options)
+    def copy_templates_to_theme(template_files, template_root, theme_path)
+      puts "--> #{template_root} - #{theme_path}"
+      mkdir_p theme_path
 
-      files_glob = "**/*{.html,.html.erb}"
+      template_files.each do |file|
+        mkdir_p theme_path + File.dirname(file)
+        cp template_root + file, theme_path + file
+      end
+    end
 
-      themes = []
+    def copy_shared_to_theme(theme, theme_path)
+      release.debug self, "Copying shared assets from #{options[:shared_folders]} for #{theme.name}"
+      shared_folders = SharedFolders.new(options[:shared_folders])
 
-      Dir.chdir(release.build_path) do
-        Dir.chdir("themes") do
-          themes = Dir.glob("*").select{|d| File.directory?(d) }.map{|t| [t, Pathname.new("themes/#{t}/theme")] }
+      shared_folders.folders.each do |source, target|
+        if File.directory? release.build_path + source.to_s
+          cp_r release.build_path + "#{source}/.", theme_path + target
         end
+      end
+    end
 
-        # Get files from html path
-        files = Dir.glob("../html/#{files_glob}").map{ |f| f.sub("../html/", "") }
-        files.reject!{|c| @options[:excludes].detect{|e| e.match(c) } }
+    def mockup(path, env = {})
+      processor = Roger::Release::Processors::Mockup.new
 
-        release.debug self, "Copying theme files #{files.inspect}"
+      release.log self, "Running mockup processor for: #{path}"
+      processor.call(release, {
+        match: [
+          path + options[:template_glob]
+        ],
+        env: {
+          "roger.project" => release.project
+        }.update(env)
+      })
+    end
 
-        themes.each do |theme, theme_dir|
-          mkdir_p theme_dir
+    def perform
+      themes_path = release.build_path + RogerThemes.themes_path
+      main_themes = Theme.main_themes(themes_path)
 
-          files.each do |file|
-            mkdir_p theme_dir + File.dirname(file)
-            cp release.project.html_path + file, theme_dir + file
-          end
+      # Get templates from html path
+      template_files = Dir.glob(release.project.html_path + options[:template_glob]).map{ |f| f.sub(release.project.html_path.to_s + "/", "") }
+      template_files.reject!{|c| options[:excludes].detect{|e| e.match(c) } }
+
+      release.debug self, "Copying theme files #{template_files.inspect}"
+
+      main_themes.each do |main_theme|
+        copy_templates_to_theme(template_files, release.project.html_path, main_theme.html_path)
+        mockup(main_theme.html_path, { "MAIN_THEME" => main_theme })
+        copy_shared_to_theme(main_theme, main_theme.path)
+
+        # Copy sub theme to MAINTHEME.SUBTHEME
+        main_theme.sub_themes.each do |sub_theme|
+          sub_theme_html_path = sub_theme.html_path_in_main(main_theme.name)
+
+          # Copy template files to main
+          copy_templates_to_theme(template_files, release.project.html_path, sub_theme_html_path)
+
+          # Run mockup
+          mockup(sub_theme_html_path, { "MAIN_THEME" => main_theme, "SUB_THEME" => sub_theme })
         end
       end
 
-      # Run mockup for each theme
-      themes.each do |theme, theme_dir|
-        match_glob = theme_dir + files_glob
-
-        mockup_processor = Roger::Release::Processors::Mockup.new()
-
-        release.log self, "Running mockup processor for theme: #{theme}"
-        mockup_processor.call(release, {
-          match: [match_glob],
-          env: {
-            "SITE_THEME" => theme,
-            "MOCKUP_PROJECT" => release.project
-          }
-        })
-
-        # cp html/images and html/fonts => html/themes/**/images && html/themes/**/fonts
-        # if not in target dir
-        # well conceptual not complete, doing so would required scanning all HTML and
-        # CSS I suppose.
-        #
-        # This means that it could be possible to get images that are not used within the
-        # zip, since these are not requried in css it wouln't cause any problems thou
-        # the zip size does increase
-        #
-        # Behavior must be simialir to the rewrite in processor
-        release.debug self, "Starting assets copy for #{@options[:shared_folders]}"
-        shared_folders = SharedFolders.new(@options[:shared_folders])
-
-        Dir.chdir(release.build_path + "themes/#{theme}") do
-          release.debug self, "Copying assets for #{theme}"
-          shared_folders.folders.each do |copy_from, copy_to|
-            if File.directory? release.build_path + copy_from.to_s
-              cp_r release.build_path + "#{copy_from}/.", copy_to
-            end
-          end
-        end
+      # Make sure we got all shared files in our sub themes
+      Theme.sub_themes(themes_path).each do |sub_theme|
+        copy_shared_to_theme(sub_theme, sub_theme.path)
       end
     end
   end

data/lib/roger_themes/theme.rb

@@ -0,0 +1,85 @@
+module RogerThemes
+  class Theme
+    attr_reader :path, :name, :manifest
+
+    # Get all themes, will cache the results for a themesepath
+    def self.all(themes_path, refresh = false)
+      @_themes ||= {}
+
+      if @_themes[themes_path] && !refresh
+        return @_themes[themes_path]
+      end
+
+      @_themes[themes_path] = Dir.glob(themes_path + "*").select{|d| File.directory?(d) }.map do |path|
+        name = path.sub(/\A#{Regexp.escape(themes_path.to_s)}/, "")
+        Theme.new(name, themes_path)
+      end
+    end
+
+    def self.sub_themes_for(main_theme_name, themes_path)
+      all(themes_path).select{|theme| theme.type == "sub" && theme.compatible_with_main?(main_theme_name) }
+
+    end
+
+    def self.main_themes(themes_path)
+      all(themes_path).select{|theme| theme.type == "main" }
+    end
+
+    def self.sub_themes(themes_path)
+      all(themes_path).select{|theme| theme.type == "sub" }
+    end
+
+    def initialize(name, themes_path)
+      @name = name.to_s.sub(/\A\//, "")
+      @themes_path = themes_path
+      @path = themes_path + @name
+      @manifest = Manifest.new(self)
+    end
+
+    def title
+      manifest[:title]
+    end
+
+    def type
+      manifest[:type]
+    end
+
+    def mains
+      manifest[:mains]
+    end
+
+    def assets
+      return [] unless manifest[:assets]
+      return @assets if @assets
+
+      @assets = manifest[:assets].map {|asset_data| Asset.new(asset_data, self) }
+    end
+
+    def sub_themes
+      self.class.sub_themes_for(name, @themes_path)
+    end
+
+    def url
+      "/" + RogerThemes.themes_path + "/" + name
+    end
+
+    # The path where the templates for this theme will reside
+    def html_path
+      self.path + "theme"
+    end
+
+    def html_path_in_main(main_theme_name)
+      path_in_main(main_theme_name) + "theme"
+    end
+
+    def path_in_main(main_theme_name)
+      @themes_path + [main_theme_name, name].join(".")
+    end
+
+    def compatible_with_main?(main_theme_name)
+      return false unless self.mains.kind_of?(Array)
+
+      mains.include?(main_theme_name)
+    end
+  end
+end

data/lib/roger_themes/version.rb

@@ -1,3 +1,3 @@
 module RogerThemes
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/roger_themes/xc_finalizer.rb

@@ -2,30 +2,34 @@ require "roger/release"
 
 module RogerThemes
   class XcFinalizer < Roger::Release::Finalizers::Base
-    attr_reader :release
+    self.name = :xc_finalizer
+
+    def default_options
+      {
+        :prefix => nil,
+        :zip => "zip",
+        :source_path => release.build_path + "themes/*",
+        :target_path => release.build_path + "themes/zips"
+      }
+    end
 
     # XC finalizer finalizes designzips.
     #
-    # @param [Release] release
     # @param [Hash] options Options hash
     # @option options [String, nil] :prefix (nil) The name to prefix the zipfile with (before version)
     # @option options [String] :zip ("zip") The ZIP command to use
     # @option options [String, Pathname] :source_path (release.build_path + "themes/*") The paths to zip
     # @option options [String, Pathname] :target_path (release.build_path + "themes/zips") The path to the zips
-    def call(release, options = {})
-      options = {
-        :prefix => nil,
-        :zip => "zip",
-        :source_path => release.build_path + "themes/*",
-        :target_path => release.build_path + "themes/zips"
-      }.update(options)
-
+    def perform()
       dirs = Dir.glob(options[:source_path].to_s)
 
       zipdir = Pathname.new(options[:target_path])
       FileUtils.mkdir_p(zipdir) unless zipdir.exist?
 
       dirs.each do |dir|
+        # Do not generate zip of intermediary zips
+        next if dir.include?(".")
+
         name = [options[:prefix], File.basename(dir), release.scm.version].compact.join("-")
         path = Pathname.new(dir)
 

data/test/fixture/html/themes/my-sub-theme/manifest.yml

@@ -0,0 +1,4 @@
+title: "My sub theme"
+type: "sub"
+mains:
+  - "my-cool-theme"

data/test/middleware_test.rb

@@ -48,13 +48,27 @@ module RogerThemes
 
     # Theme links work by means of rewriting the path info i.e.
     # to render and setting the env[site_theme] var
-    def test_theme_links
+    def test_main_theme_url
       @request.get("/themes/my-awesome-theme/theme/elements/index.html")
       assert_equal @app.call_stack.length, 1
-      assert_equal @app.call_stack[0]["SITE_THEME"], "my-awesome-theme"
+      assert_equal @app.call_stack[0]["MAIN_THEME"].name, "my-awesome-theme"
       assert_equal @app.call_stack[0]["PATH_INFO"], "elements/index.html"
     end
 
+    def test_sub_theme_url
+      @request.get("/themes/my-awesome-theme.my-sub-theme/theme/elements/index.html")
+      assert_equal @app.call_stack.length, 1
+      assert_equal @app.call_stack[0]["MAIN_THEME"].name, "my-awesome-theme"
+      assert_equal @app.call_stack[0]["SUB_THEME"].name, "my-sub-theme"
+      assert_equal @app.call_stack[0]["PATH_INFO"], "elements/index.html"
+    end
+
+    def test_local_main_theme_url
+      @request.get("/themes/my-awesome-theme/index.html")
+      assert_equal @app.call_stack.length, 1
+      assert_equal @app.call_stack[0]["PATH_INFO"], "/themes/my-awesome-theme/index.html"
+    end
+
     def test_shared_resources
       # Shared resource will update the PATH_INFO to render a shared image or font
       @app.return_value = [404, {}, ["YAM"]]

data/test/processor_test.rb

@@ -20,6 +20,7 @@ module RogerThemes
 
     def test_processor_can_be_called
       assert(@processor.respond_to?(:call))
+      assert(@processor.respond_to?(:perform))
     end
 
     def test_processor_copies_shared_folders
@@ -50,7 +51,9 @@ module RogerThemes
     protected
 
     def read_file_in_build(path)
-      File.read((@release.build_path + path).to_s)
+      full_path = (@release.build_path + path).to_s
+      assert File.exist?(full_path)
+      File.read(full_path)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roger_themes
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Edwin van der Graaf
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-16 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roger
@@ -116,13 +116,17 @@ files:
 - README.md
 - Rakefile
 - lib/roger_themes.rb
+- lib/roger_themes/asset.rb
+- lib/roger_themes/manifest.rb
 - lib/roger_themes/middleware.rb
 - lib/roger_themes/processor.rb
 - lib/roger_themes/shared_folders.rb
+- lib/roger_themes/theme.rb
 - lib/roger_themes/version.rb
 - lib/roger_themes/xc_finalizer.rb
 - roger_themes.gemspec
 - test/fixture/html/themes/my-awesome-theme/index.html
+- test/fixture/html/themes/my-sub-theme/manifest.yml
 - test/middleware_test.rb
 - test/processor_test.rb
 - test/shared_folders_test.rb
@@ -147,12 +151,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Create themes and release them as static site
 test_files:
 - test/fixture/html/themes/my-awesome-theme/index.html
+- test/fixture/html/themes/my-sub-theme/manifest.yml
 - test/middleware_test.rb
 - test/processor_test.rb
 - test/shared_folders_test.rb