flatrack 1.3.3 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4712856b901f1113021c85dcd49feb181318fbc5
-  data.tar.gz: 9234ce5891267c17e254b3953bb2219a4e4a2dfe
+  metadata.gz: 2d13c4d84da9f6348b2d63a2b12ba6e76f422a1a
+  data.tar.gz: c3d9bfc0ec684c2922edfe260e92fbfbb994a793
 SHA512:
-  metadata.gz: 39da8a5e1fce769e1d847d74cbdeb8642d484650ffd5a533872ef56a442799ad7ffd1a7f8c24375487541967108ee5b0b7c13567664c59e7e8b3fac8c4d472af
-  data.tar.gz: ab7fcf8c901f5613006707a6c23432f8c6723e6ed7010300c55cf503bce952cb14554d3a7442e80e694b5ce5d8936ebd6630cf350fb942ffea7dba60ea3a642b
+  metadata.gz: 73606292ae76a830287a1b6426df26f31fb6695eccdd4ec43ab01adb322bfe210e33a08c38b23f7afc8e9301e27d10bed724a82e6d62f5d82e43ae2548082db6
+  data.tar.gz: f96358443ba28a52c4d8736818b7c7b9d8f26cd0d8bb6b189799438da3246568bdac01874376e3249be0914ed53dc2eb830acd733a0f822bf8a74e80b05dd6ad

data/.gitignore

@@ -4,6 +4,7 @@ pkg/*
 tmp
 coverage
 /.sass-cache/
+.bundle
 
 /.yardoc/
 

data/.ruby-version

@@ -1 +1 @@
-2.1.3
+2.2.0

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
+sudo: false
 rvm:
   - 2.0.0
-  - 2.1.1
-  - 2.1.2
-  - 2.1.2
-  - 2.2.0-preview1
+  - 2.1.5
+  - 2.2.0
 cache: bundler
 after_success:
   - bundle exec inch
@@ -12,5 +11,3 @@ after_success:
 
 matrix:
   fast_finish: true
-  allow_failures:
-    - rvm: 2.2.0-preview1

data/flatrack.gemspec

@@ -30,14 +30,15 @@ based routing.
 
   # Dependencies
   spec.add_runtime_dependency 'rack', '~> 1.4'
+  spec.add_runtime_dependency 'rack-contrib', '~> 1.2'
   spec.add_runtime_dependency 'erubis', '~> 2.7'
   spec.add_runtime_dependency 'tilt', '~> 1.1'
-  spec.add_runtime_dependency 'activesupport', ['> 3.2', '< 4.2']
-  spec.add_runtime_dependency 'sass', '~> 3.2.0'
+  spec.add_runtime_dependency 'activesupport', ['> 3.2', '< 5.0']
+  spec.add_runtime_dependency 'sass', '~> 3.2'
   spec.add_runtime_dependency 'sprockets-sass', '~> 1.2'
   spec.add_runtime_dependency 'thor', '~> 0.18'
   spec.add_runtime_dependency 'coffee-script', '~> 2.2'
-  spec.add_runtime_dependency 'rake', ['> 0.8.7', '< 10.2']
+  spec.add_runtime_dependency 'rake', ['> 0.8.7', '< 10.4']
 
   # Dev Dependencies
   spec.add_development_dependency 'bundler', '~> 1.5'

data/lib/custom-extensions/sprockets-sass.rb

@@ -0,0 +1,32 @@
+require 'sprockets'
+require 'sprockets/sass/version'
+require 'sprockets/sass/sass_template'
+require 'sprockets/sass/scss_template'
+require 'sprockets/engines'
+
+module Sprockets
+  module Sass
+    autoload :CacheStore, 'sprockets/sass/cache_store'
+    autoload :Compressor, 'sprockets/sass/compressor'
+    autoload :Importer,   'sprockets/sass/importer'
+
+    class << self
+      # Global configuration for `Sass::Engine` instances.
+      attr_accessor :options
+
+      # When false, the asset path helpers provided by
+      # sprockets-helpers will not be added as Sass functions.
+      # `true` by default.
+      attr_accessor :add_sass_functions
+    end
+
+    @options = {}
+    @add_sass_functions = true
+
+    # Allow to fallback to real sass
+    def self.const_missing(const)
+      ::Sass.const_get const
+    end
+    
+  end
+end

data/lib/flatrack.rb

@@ -1,10 +1,10 @@
 require 'flatrack/version'
 require 'active_support/all'
-require 'sprockets'
-require 'sprockets-sass'
+require 'custom-extensions/sprockets-sass'
 require 'coffee-script'
 require 'sass'
 require 'rack'
+require 'rack/contrib'
 
 # A static site generator with a little sprinkle of ruby magic
 class Flatrack
@@ -17,15 +17,26 @@ class Flatrack
   autoload :Site
   autoload :AssetExtensions
   autoload :CLI
+  autoload :Middleware
+  autoload :Rewriter
+  autoload :Redirector
+  autoload :DomainParser
+
+  Redirector
+  Rewriter
 
   # @private
   TemplateNotFound = Class.new StandardError
   # @private
   FileNotFound     = Class.new StandardError
   # @private
-  FORMATS = {}
+  FORMATS          = {}
+  # @private
+  MAPPING          = { '/assets' => :assets, '/' => :site }
 
-  delegate :gem_root, :site_root, to: self
+  delegate :gem_root, to: self
+  delegate :call, to: :builder
+  attr_accessor :raise_errors
 
   class << self
     # The root of the flatrack gem
@@ -39,14 +50,20 @@ class Flatrack
     # @!attribute [r] site_root
     # @return [String]
     def site_root
-      File.expand_path Dir.pwd
+      Dir.pwd
     end
 
     # Reset the state of flatrack and its configuration
+    # For testing
+    # @private
     def reset!
       @delegate_instance = nil
     end
 
+    def site=(instance)
+      @delegate_instance = instance
+    end
+
     private
 
     def delegate_instance
@@ -61,9 +78,12 @@ class Flatrack
   # Configure the flatrack instance
   # @yield [Flatrack] configuration for the flatrack instance
   # @return [Flatrack]
-  def config(&block)
-    yield self
-    self
+  def config
+    yield self if block_given?
+    OpenStruct.new(
+      site_root:    site_root,
+      raise_errors: raise_errors
+    ).freeze
   end
 
   # The flatrack sprockets environment
@@ -71,10 +91,13 @@ class Flatrack
   # @return [Sprockets::Environment]
   def assets
     @assets ||= begin
+      Sass.load_paths << File.join(site_root, 'assets/stylesheets')
       Sprockets::Environment.new.tap do |environment|
-        environment.append_path 'assets/images'
-        environment.append_path 'assets/javascripts'
-        environment.append_path 'assets/stylesheets'
+        environment.register_engine '.sass', Sprockets::Sass::SassTemplate
+        environment.register_engine '.scss', Sprockets::Sass::ScssTemplate
+        environment.append_path File.join site_root, 'assets/images'
+        environment.append_path File.join site_root, 'assets/javascripts'
+        environment.append_path File.join site_root, 'assets/stylesheets'
         environment.context_class.class_eval { include AssetExtensions }
       end
     end
@@ -88,10 +111,54 @@ class Flatrack
   end
 
   # The middleware stack for flatrack
+  # @!attribute [r] middleware
+  # @return [Hash]
   def middleware
     @middleware ||= []
   end
 
+  # This is for testing
+  # @private
+  def mock_env_for(url, opts={})
+    env = Rack::MockRequest.env_for url, opts
+    env.merge! env_extensions
+  end
+
+  # Rewrite a path
+  # @param source [String]
+  # @param to [String]
+  def rewrite(source, to: nil)
+    unless [source, to].all? { |path| path.is_a? String }
+      raise ArgumentError, 'mappings must be strings'
+    end
+    rewrites.merge! source => to
+  end
+
+  # redirect a path
+  # @param source [String]
+  # @param to [String]
+  # @param type [Symbol]
+  def redirect(source, to: nil, type: :permanent)
+    unless [source, to].all? { |path| path.is_a? String }
+      raise ArgumentError, 'mappings must be strings'
+    end
+    redirects.merge! source => Redirector::Redirect.new(to, type)
+  end
+
+  # The rewrites
+  # @!attribute [r] rewrites
+  # @return [Hash]
+  def rewrites
+    @rewrites ||= {}
+  end
+
+  # The redirects
+  # @!attribute [r] redirects
+  # @return [Hash]
+  def redirects
+    @redirects ||= {}
+  end
+
   # Insert a rack middleware at the end of the stack
   # @param middleware [Class] the middleware class
   # @param options [Hash] the options for the middleware
@@ -99,6 +166,51 @@ class Flatrack
     self.middleware << [middleware, options].compact
   end
 
+  def site_root=(path)
+    path = File.expand_path path
+    Template.register_path path
+    @site_root = path
+  end
+
+  # The site root
+  # @!attribute [r] site_root
+  # @return [String]
+  def site_root
+    @site_root || (self.site_root = self.class.site_root)
+  end
+
+  # Returns the site lambda
+  # @return [Proc]
+  def site
+    lambda { |env|
+      env.merge! env_extensions
+      Request.new(env).response
+    }
+  end
+
+  private
+
+  def builder
+    @builder ||= begin
+      this = self
+      Rack::Builder.app do
+        use Rack::Cookies
+        use DomainParser
+        use Flatrack::Rewriter, this.rewrites if this.rewrites.present?
+        use Flatrack::Redirector, this.redirects if this.redirects.present?
+        use Rack::Static,
+            urls: ['/favicon.ico', 'assets'],
+            root: File.join(this.site_root, 'public')
+        this.middleware.each { |mw| use *mw }
+        MAPPING.each { |path, app| map(path) { run this.send(app) } }
+      end
+    end
+  end
+
+  def env_extensions
+    { 'flatrack.config' => self.config }
+  end
+
   # By default we know how to render 'text/html'
   register_format :html, 'text/html'
 

data/lib/flatrack/asset_extensions.rb

@@ -5,7 +5,13 @@ class Flatrack
     # @param path [String] the asset name or path
     # @return [String]
     def asset_path(path, _ = {})
-      File.join('/assets', path.to_s)
+      File.join('/', mount_path, 'assets', path.to_s)
+    end
+
+    def mount_path
+      a = singleton_class.ancestors
+      has_super = a[a.index(AssetExtensions) + 1].method_defined? __method__
+      has_super ? super : '/'
     end
   end
 end

data/lib/flatrack/cli.rb

@@ -58,11 +58,19 @@ class Flatrack
 
     method_option :verbose, type: :boolean, default: true, aliases: :v
     method_option :port, type: :numeric, default: 5959, aliases: :p
+    method_option :root, default: Dir.pwd, type: :string, aliases: :r
 
     desc 'start --port PORT', 'run the site on the given port'
     # Start the app
     def start
-      require './boot'
+      Flatrack.config do |config|
+        config.site_root   = options[:root]
+      end
+      begin
+        require File.join Dir.pwd, 'boot'
+      rescue LoadError
+        nil
+      end
       run_opts             = {}
       run_opts[:app]       = Flatrack::Site
       run_opts[:Port]      = options[:port]

data/lib/flatrack/domain_parser.rb

@@ -0,0 +1,13 @@
+class Flatrack
+  class DomainParser < Struct.new :app
+
+    def call(env)
+      *subdomains, host, tld = env['SERVER_NAME'].split '.'
+      env['domain.sub']      = subdomains.join '.'
+      env['domain.host']     = host
+      env['domain.tld']      = tld
+      app.call(env)
+    end
+
+  end
+end

data/lib/flatrack/middleware.rb

@@ -0,0 +1,32 @@
+class Flatrack
+  class Middleware
+
+    def initialize(app, opts = {})
+      @if      = opts[:if] || Proc.new { true }
+      @unless  = opts[:unless] || Proc.new { false }
+      @app          = app
+      @flatrack_app = opts[:flatrack_app] || Flatrack::Site
+    end
+
+    def call(env)
+      Flatrack::DomainParser.new(null_app).call(env)
+      allow = @if.call(env) && !@unless.call(env)
+      return call_app env unless allow
+      response = @flatrack_app.call env
+      status, _, _ = response
+      response     = call_app(env) if status == 404
+      response
+    rescue Flatrack::FileNotFound
+      call_app env
+    end
+
+    def call_app(env)
+      @app.call env
+    end
+
+    def null_app
+      ->(_){}
+    end
+
+  end
+end

data/lib/flatrack/redirector.rb

@@ -0,0 +1,63 @@
+class Flatrack
+  def Redirector(source, opts={})
+    to    = opts.delete(:to)
+    type  = opts.delete(:type) || :permanent
+    klass = Class.new(Redirector)
+    klass.send(:define_method, :initialize) do |app, mw_opts|
+      mapping = { source => Redirector::Redirect.new(to, type) }
+      super app, mapping, mw_opts
+    end
+    klass
+  end
+
+  class Redirector
+
+    def initialize(app, mapping = {}, opts = {})
+      @if      = opts[:if] || Proc.new { true }
+      @unless  = opts[:unless] || Proc.new { false }
+      @app     = app
+      @mapping =
+        Hash[mapping.map { |k, v| [File.join('', k), v] }]
+    end
+
+    def call(env)
+      allow = @if.call(env) && !@unless.call(env)
+      if allow && @mapping.keys.include?(env['PATH_INFO'])
+        @mapping[env['PATH_INFO']].response
+      else
+        @app.call env
+      end
+    end
+
+    private
+
+    class Redirect
+
+      attr_reader :url, :type
+
+      def initialize(url, type = :permanent)
+        @url, @type = url, type
+        code # just to check args
+      end
+
+      # Returns the code for the specified type
+      # @returns [Fixnum]
+      def code
+        case type.to_sym
+        when :permanent
+          301
+        when :temporary
+          302
+        else
+          raise ArgumentError, 'type must be :temporary or :permanent'
+        end
+      end
+
+      def response
+        [code, { 'location' => url }, ["you are being redirected to: `#{url}`"]]
+      end
+
+    end
+
+  end
+end