roger_themes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bce0af5e073b8ec748ab99636295b43d8764c2e8
+  data.tar.gz: 45a91b6a5d59d925ae3ef4e969de0225dbb61bb4
+SHA512:
+  metadata.gz: 723ed580109365f22b364214a8e238ff181fe4a2845270e4d830e21eb35ffffd5714da1865e85b12867fd7c39cdecbfda8f687f5c5d12feb4033df9cdfedbe7d
+  data.tar.gz: c9f3d9cdab3a033c21d8448be76e0114374d9dee74143814c5ddf44f611c9f48b07768311b3b475ca95a44010b2c567f7a2a129f5ff904ba6ab8cd8ac69255b4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop

@@ -0,0 +1,3 @@
+# Don't give me rails thingies
+AllCops:
+  RunRailsCops: false

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in roger_themes.gemspec
+gemspec
+
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Edwin van der Graaf
+
+MIT License
+
+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,71 @@
+# RogerThemes
+
+Create themes and release them as static site.
+
+## Themes setup
+
+Your themes live in the themes dir, it will release all pages for your themes
+into the theme dir.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'roger_themes'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Todo
+
+- [] Add tests
+- [] Complete documentation (especially on how themes work by default)
+- [] Add theme selector views for usage in table of content
+
+## Usage
+
+Include the middleware and processor in the `serve` and `release` block:
+
+```
+mockup.serve do |s|
+    s.use RogerThemes::Middleware
+    # ...
+end
+```
+
+```
+mockup.release do |r|
+    # ..
+    r.use :themes
+
+    # Finalise your zips for XC
+    r.finalize RogerThemes::XcFinalizer
+```
+
+## Changelog
+
+### v0.1.0
+
+* `:shared_folders` now also takes a hash to enable nested theme folders
+  ```
+    {
+        shared_folders: {"images" => "rel/images"}
+    }
+  ```
+* Remove `rel` from shared_folders
+
+### v0.0.1 (never released)
+
+* Initial release
+
+## Contributing
+
+1. Fork it ( https://github.com/digitpaint/roger_themes/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+task default: [:test, :rubocop]
+
+desc "Run rubocop"
+task :rubocop do
+  RuboCop::RakeTask.new
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/*_test.rb"]
+  t.verbose = false
+end

data/lib/roger_themes.rb

@@ -0,0 +1,9 @@
+require "roger_themes/version"
+
+module RogerThemes
+  # Your code goes here...
+end
+
+require "roger_themes/middleware"
+require "roger_themes/processor"
+require "roger_themes/xc_finalizer"

data/lib/roger_themes/middleware.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + "/shared_folders"
+
+module RogerThemes
+  class Middleware
+    def initialize(app, options = {})
+      @app = app
+
+      defaults = {
+        default_theme: "default",
+        shared_folders: ["images", "fonts"]
+      }
+
+      @options = defaults.update(options)
+      @shared_folders = SharedFolders.new(@options[:shared_folders])
+    end
+
+    def call(env)
+      path = ::Rack::Utils.unescape(env["PATH_INFO"])
+      r = /\A\/themes\/([^\/]+)\/theme\//
+      if theme = path[r,1]
+        orig_path = env["PATH_INFO"].dup
+        env["SITE_THEME"] = theme
+        env["PATH_INFO"].sub!(r,"")
+      else
+        # Set default theme
+        env["SITE_THEME"] = @options[:default_theme]
+      end
+
+      ret = @app.call(env)
+
+      # Fallback for shared images
+      unless ret[0] == 200
+
+        shared_path = @shared_folders.local_to_shared_path(path)
+
+        if shared_path
+          # Store so we can restore later
+          orig_path = env["PATH_INFO"].dup
+          env["PATH_INFO"] = shared_path
+        end
+
+        ret = @app.call(env)
+
+        # Restore path so we are nice with everybody else
+        env["PATH_INFO"] = orig_path
+      end
+
+      ret
+    end
+  end
+end

data/lib/roger_themes/processor.rb

@@ -0,0 +1,83 @@
+require "roger/release/processors/mockup"
+
+module RogerThemes
+  class Processor < Roger::Release::Processors::Base
+    def initialize(options = {})
+
+      defaults = {
+        default_theme: 'default',
+        excludes: [
+          /\A_doc\/.*/,
+          /\Athemes\/.*/,
+          "index.html"
+        ],
+        shared_folders: ["images", "fonts"]
+      }
+
+      @options = defaults.update(options)
+    end
+
+    def call(release, options)
+      @options = @options.dup.update(options)
+
+      files_glob = "**/*{.html,.html.erb}"
+
+      themes = []
+
+      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")] }
+        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) } }
+
+        release.debug self, "Copying theme files #{files.inspect}"
+
+        themes.each do |theme, theme_dir|
+          mkdir_p theme_dir
+
+          files.each do |file|
+            mkdir_p theme_dir + File.dirname(file)
+            cp release.project.html_path + file, theme_dir + file
+          end
+        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({
+          match: [match_glob],
+          env: {
+            "SITE_THEME" => theme,
+            "MOCKUP_PROJECT" => release.project
+          }
+        })
+        mockup_processor.call(release)
+
+        # 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|
+            cp_r release.build_path + copy_from, copy_to
+          end
+        end
+      end
+    end
+  end
+end

data/lib/roger_themes/shared_folders.rb

@@ -0,0 +1,32 @@
+module RogerThemes
+  class SharedFolders
+    def initialize(folders)
+      # To allow shared_folders to passed in as array
+      # in cases the mapping becomes 1:1 update shared_folders to Hash
+      if folders.is_a? Array
+        paths = folders.map { |v| [v, v] }
+        @folders = Hash[paths]
+      else
+        @folders = folders
+      end
+    end
+
+    # Takes an local theme path
+    # and tries to resolve this to
+    # shared path
+    def local_to_shared_path(path)
+      matched_shared = @folders.detect do |folder_to, folder_from|
+        if path[/\A\/themes\/([^\/]+)\/#{folder_from}\//, 1]
+          [folder_to, folder_from]
+        end
+      end
+
+      if matched_shared
+        path.sub(/\A\/themes\/([^\/]+)\/#{matched_shared[1]}/,
+                 "/#{matched_shared[0]}")
+      else
+        false
+      end
+    end
+  end
+end

data/lib/roger_themes/version.rb

@@ -0,0 +1,3 @@
+module RogerThemes
+  VERSION = "0.1.0"
+end

data/lib/roger_themes/xc_finalizer.rb

@@ -0,0 +1,37 @@
+module RogerThemes
+  class XcFinalizer < Roger::Release::Finalizers::Base
+    attr_reader :release
+
+    def call(release, options = {})
+      dirs = Dir.glob((release.build_path + "themes/*").to_s)
+
+      options = {
+        :prefix => "html",
+        :zip => "zip"
+      }.update(options)
+
+      releasename = [(options[:prefix] || "html"), release.scm.version].join("-")
+
+      zipdir = release.build_path + "themes/zips"
+      FileUtils.mkdir_p(zipdir) unless zipdir.exist?
+
+      dirs.each do |dir|
+        name = File.basename(dir)
+        path = Pathname.new(dir)
+
+        begin
+          `#{options[:zip]} -v`
+        rescue Errno::ENOENT
+          raise RuntimeError, "Could not find zip in #{options[:zip].inspect}"
+        end
+
+        ::Dir.chdir(path) do
+          `#{options[:zip]} -r -9 "#{zipdir + name}-#{release.scm.version}.zip" rel js`
+        end
+
+        release.log(self, "Creating zip for custom #{name}")
+
+      end
+    end
+  end
+end

data/roger_themes.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "roger_themes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "roger_themes"
+  spec.version       = RogerThemes::VERSION
+  spec.authors       = ["Edwin van der Graaf"]
+  spec.email         = ["edwin@digitpaint.nl"]
+  spec.summary       = "Create themes and release them as static site"
+  spec.homepage      = "https://github.com/digitpaint/roger_themes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "roger", "~> 1.0"
+  spec.add_dependency "rack"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit", "~> 3.1.2"
+  spec.add_development_dependency "simplecov", "~> 0.10.0"
+  spec.add_development_dependency "rubocop", "~> 0.31.0"
+end

data/test/middleware_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+require "./lib/roger_themes/middleware"
+
+require "rack/mock"
+
+module RogerThemes
+  class TestMiddleware < ::Test::Unit::TestCase
+
+    def setup
+      @app =  proc { [200, {}, ["YAM"]] } # Yet another middleware
+      @middleware = Middleware.new @app
+
+      @request = Rack::MockRequest.new(@middleware)
+    end
+
+    def test_middleware_can_be_called
+      assert(@middleware.respond_to?(:call))
+    end
+
+    def test_doesnt_touch_other_requests
+      assert_equal @request.get("/my.js").body, "YAM"
+    end
+
+  end
+end

data/test/shared_folders_test.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+require "./lib/roger_themes/shared_folders"
+
+require "rack/mock"
+
+module RogerThemes
+  class TestSharedFolders < ::Test::Unit::TestCase
+    def setup
+      @shared_folders = SharedFolders.new(["images", "fonts"])
+    end
+
+    def test_simple_case_with_array
+      shared_path = @shared_folders.local_to_shared_path("/themes/default/fonts/")
+      assert_equal "/fonts/", shared_path
+    end
+
+    def test_with_hash
+      @shared_folders = SharedFolders.new("fonts" => "rel/fonts",
+                                          "images" => "rel/images")
+
+      shared_path = @shared_folders.local_to_shared_path("/themes/default/rel/fonts/")
+      assert_equal "/fonts/", shared_path
+    end
+
+    def test_returns_false_when_no_shared_folder
+      shared_path = @shared_folders.local_to_shared_path("/themes/default/not_found/")
+      assert !shared_path
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "simplecov"
+SimpleCov.start
+
+require "test/unit"
+require "pry"

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: roger_themes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edwin van der Graaf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.31.0
+description: 
+email:
+- edwin@digitpaint.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/roger_themes.rb
+- lib/roger_themes/middleware.rb
+- lib/roger_themes/processor.rb
+- lib/roger_themes/shared_folders.rb
+- lib/roger_themes/version.rb
+- lib/roger_themes/xc_finalizer.rb
+- roger_themes.gemspec
+- test/middleware_test.rb
+- test/shared_folders_test.rb
+- test/test_helper.rb
+homepage: https://github.com/digitpaint/roger_themes
+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.5
+signing_key: 
+specification_version: 4
+summary: Create themes and release them as static site
+test_files:
+- test/middleware_test.rb
+- test/shared_folders_test.rb
+- test/test_helper.rb