mosaic 0.0.1pre

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_STORE

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+ - 1.8.7
+ - 1.9.3
+ - rbx-18mode
+ - rbx-19mode
+ - ruby-head
+env:
+ - "rake=0.8"
+script: "bundle exec rspec"
+matrix:
+  allow_failures:
+    - rvm: rbx-18mode
+    - rvm: rbx-19mode
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mosaic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Laycock (Arcath)
+
+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,29 @@
+# Mosaic
+
+[![Status](https://secure.travis-ci.org/Arcath/mosaic.png?branch=master)](http://travis-ci.org/Arcath/mosaic)
+
+A simple MOdular Sinatra ApplICation framework.
+
+## Installation
+
+Install via rubygems using:
+
+    $ gem install mosaic
+
+## Usage
+
+Create a new mosaic application using:
+
+    $ mosaic new NAME
+
+where NAME is the name of your new application.
+
+This gives you a very basic application with the basic folder structure required to make it work.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/mosaic

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "mosaic/bin"
+
+Mosaic::Bin.new(ARGV)

data/lib/blank_app/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+# Mosaic Gem
+gem 'mosaic'
+
+# Mosaic Required Gems
+gem 'sinatra-static-assets', require: 'sinatra/static_assets'
+
+# Your Gems
+#gem 'sass' # Required for Mosaic::Modules::Sass

data/lib/blank_app/app/modules/example.rb

@@ -0,0 +1,7 @@
+class ExampleModule < Mosaic::Module
+  respond_to :get, "/example"
+  
+  def handle
+    @response.content = :'index.html'
+  end
+end

data/lib/blank_app/config.ru

@@ -0,0 +1,11 @@
+require 'rubygems'
+require "bundler"
+
+Bundler.require
+Mosaic.set_root File.dirname(__FILE__)
+
+require './config/mosaic'
+
+require 'mosaic/application'
+
+run Mosaic::Application

data/lib/blank_app/config/mosaic.rb

@@ -0,0 +1,7 @@
+# Moasic Provided Modules
+require 'mosaic/modules/static' # Static Content Handling
+require 'mosaic/modules/info' # Info Page (Comment out in production)
+#require 'mosaic/modules/sass' # SASS Middleware (needs sass in your Gemfile)
+
+# Require all modules in app/modules
+Dir.glob(Mosaic.root + '/app/modules/*', &method(:require))

data/lib/blank_app/public/stylesheets/application.css

@@ -0,0 +1,3 @@
+body{
+	font-family:helvetica, sans-serif;
+}

data/lib/blank_app/views/index.html.erb

@@ -0,0 +1,5 @@
+<h1>Welcome to your new Mosaic Application</h1>
+<h2><a href="/__mosaic__/info">Application Info</a></h2>
+<h3>Where Next?</h3>
+<p>Start by getting rid of the content in <i>/views/index.html.erb</i> you dont want this as a home page.</p>
+<p>Head over to <a href="http://mosaic.arcath.net/">mosaic.arcath.net</a> and look at some of the modules listed there.</p>

data/lib/blank_app/views/layouts/application.html.erb

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<title>Mosaic</title>
+	<%= stylesheet_link_tag "/css/application.css" %>
+</head>
+<body>
+	<%= yield %>
+</body>
+</html>

data/lib/mosaic.rb

@@ -0,0 +1,27 @@
+# Main Mosaic Module, all code is contained within this Module
+module Mosaic
+  
+  # Sets the root path, used in the users application to set the root to the applications root
+  def self.set_root(path)
+    @root = path
+  end
+  
+  # Returns the root path, used by Moasic::Application
+  def self.root
+    @root
+  end
+  
+  # Data stores container
+  module Stores
+  end
+end
+
+# Sinatra
+require 'sinatra'
+# Version
+require "mosaic/version"
+# Classes
+require "mosaic/module"
+require "mosaic/response"
+# Stores
+require "mosaic/stores/yaml"

data/lib/mosaic/application.rb

@@ -0,0 +1,30 @@
+module Mosaic
+  # Sinatra Application
+  # Used in config.ru to create the application and run it
+  class Application < Sinatra::Base
+    set :sessions, true
+    set :root, Mosaic.root if Mosaic.root
+    
+    # Provides rails like helper methods e.g. link_to
+    register Sinatra::StaticAssets
+    
+    puts "Middleware load order:"
+    
+    Mosaic.middleware.each do |middleware|
+      puts middleware.inspect
+      use middleware
+    end
+    
+    puts "Route load order:"
+    
+    Mosaic.responders.keys.sort.reverse.each do |key|
+      puts key
+      self.send(Mosaic.responders[key][1], key) do
+        @responder = Mosaic.responders[key][0].new(request, key)
+        @responder.handle
+        @params = request.params
+        self.send(@responder.response.view_format, @responder.response.content, :layout => @responder.response.layout)
+      end
+    end
+  end
+end

data/lib/mosaic/bin.rb

@@ -0,0 +1,41 @@
+module Mosaic
+  # The mosaic command class, used to create new applications
+  class Bin
+    def initialize(args)
+      @args = args
+      @root_path = File.expand_path("../../../", __FILE__)
+      handle_arguments
+    end
+    
+    private
+    
+    def handle_arguments
+      if @args.include?("new")
+        new_application
+      else
+        help_page
+      end
+    end
+    
+    def help_page
+      puts "MOSAIC"
+      puts "MOdular Sinatra ApplICation"
+      puts ""
+      puts "Usage:"
+      puts "\tmosaic new [name]"
+      puts "\t\tcreates a new mosaic application with the supplied name"
+    end
+    
+    def new_application
+      application_name = @args[@args.index("new") + 1]
+      copy_command = "cp -r #{@root_path}/lib/blank_app ./#{application_name}"
+      puts "Creating new application \"#{application_name}\""
+      system(copy_command)
+      puts "Empty app copied!"
+      puts "Running bundler"
+      system("cd #{application_name}; bundle install")
+      puts "Application Created!"
+      puts "cd to #{application_name} to begin"
+    end
+  end
+end

data/lib/mosaic/module.rb

@@ -0,0 +1,71 @@
+module Mosaic
+  # A hash of paths with response classes e.g.
+  #    "/foo" => [FooHandler, :get]
+  def self.responders
+    @responders || {}
+  end
+  
+  # An Array of middleware to be loaded by Mosaic::Application
+  def self.middleware
+    @middleware || []
+  end
+  
+  # Adds a responder to the hash
+  def self.add_response(type, path, mod)
+    @responders ||= {}
+    @responders[path] = [mod, type]
+  end
+  
+  # Adds a piece middleware to the array
+  def self.add_middleware(middleware)
+    @middleware ||= []
+    @middleware.push(middleware)
+  end
+  
+  # The master class for all modules
+  # Should be inhertied by any class that gets used in Mosaic::Aplication
+  class Module
+    attr_reader :response, :params, :request
+    
+    # Creates a new responder, called by Mosaic::Application for every request that uses a given module
+    # Takes the request object and the current path as input
+    def initialize(request, path)
+      @request = request
+      @response = Mosaic::Response.new(request)
+      @params = request.params
+      chunks = path.split("/").collect { |x| x if x =~ /:/ }
+      chunks.each do |chunk|
+        if chunk
+          key = chunk.gsub(/:/,'')
+          key.gsub!(/(.*?)\./,'')
+          key.gsub!(/\?/,'')
+          @params[key.to_sym] = @request.path_info.split("/")[path.split("/").index(chunk)]
+        end
+      end
+    end
+    
+    # Class method for modules, if called the responder is declaring that it is capable of handling requests of the supplied type for the supplied path
+    # Called as:
+    #    respond_to :get, "/foo"
+    def self.respond_to(type, path)
+      Mosaic.add_response(type, path, self)
+    end
+    
+    # Class method for modules, adds the supplied class to the middleware array
+    # Called as:
+    #    provide_middleware Foo:Middleware
+    def self.provide_middleware(middleware)
+      Mosaic.add_middleware(middleware)
+    end
+    
+    private
+    
+    def contained_view(file)
+      File.read(File.expand_path("../../../support/views/#{file}", __FILE__))
+    end
+  end
+  
+  # Container for modules supplied with Mosaic
+  module Modules
+  end
+end

data/lib/mosaic/modules/info.rb

@@ -0,0 +1,21 @@
+module Mosaic
+  module Modules
+    # Info page for Mosaic
+    class Info < Mosaic::Module
+      respond_to :get, "/__mosaic__/info"
+      
+      # Returns the contained view for the page
+      def handle
+        @response.layout = contained_view("info/layout.html.erb")
+        @response.content = contained_view("info/index.html.erb")
+      end
+      
+      # A hash of info used by the info page
+      def info
+        {
+          root: File.expand_path("../../../../", __FILE__)
+        }
+      end
+    end
+  end
+end

data/lib/mosaic/modules/sass.rb

@@ -0,0 +1,10 @@
+require 'sass/plugin/rack'
+
+module Mosaic
+	module Modules
+    # Loads the SASS middleware and includes it in the middleware array
+		class Sass < Mosaic::Module
+      provide_middleware ::Sass::Plugin::Rack
+		end
+	end
+end

data/lib/mosaic/modules/static.rb

@@ -0,0 +1,43 @@
+module Mosaic
+  # Return the inbuilt 404 page
+  def self.error404
+    File.read(File.expand_path("../../../../support/views/errors/error404.html.erb", __FILE__))
+  end
+  
+  module Modules
+    # Static view system.
+    # Allows requests to be made for files in the views folder
+    # Will always be at the bottom of the response list
+    class Static < Mosaic::Module
+      respond_to :get, '*'
+      
+      # Set the response file to the requested view
+      def handle
+        @response.response_code = response_code
+        @response.content = view
+        @response.layout = set_layout
+        @response.output_format = @request.path_info.split(".").last
+      end
+      
+      # Work out what view to serve
+      def file
+        "#{@request.path_info}.html".gsub(/\/\./, 'index.')
+      end
+      
+      # Return the 404 view if needed
+      def view
+        response_code == 200 ? file.to_sym : Mosaic.error404
+      end
+      
+      # Use no layout for 404
+      def set_layout
+        response_code == 200 ? :"layouts/application.#{@response.output_format}" : nil
+      end
+      
+      # Work out the response code
+      def response_code
+        File.exists?("views/#{file}.erb") ? 200 : 404
+      end
+    end
+  end
+end

data/lib/mosaic/response.rb

@@ -0,0 +1,15 @@
+module Mosaic
+  # Used to build a response for sinatra to serve
+  class Response
+    attr_accessor :content, :layout, :response_code, :view_format, :output_format
+    attr_reader :request
+    
+    def initialize(request)
+      @view_format = :erb
+      @output_format = :html
+      @layout = :'layouts/application'
+      @request = request
+      @response_code = 200
+    end
+  end
+end

data/lib/mosaic/stores/yaml.rb

@@ -0,0 +1,35 @@
+require 'fileutils'
+
+module Mosaic
+  module Stores
+    # Store data in yaml files
+    class Yaml
+      attr_reader :yaml
+      
+      def initialize(name)
+        @store = name
+        @directory = "#{Mosaic.root}/app/stores"
+        begin
+          @yaml = YAML::load(File.open("#{@directory}/#{@store}.yml"))
+        rescue
+          create_file_and_folder
+          @yaml = YAML::load(File.open("#{@directory}/#{@store}.yml"))
+        end
+      end
+      
+      # Create the files and folders if they are missing
+      def create_file_and_folder
+        begin
+          Dir::mkdir(@directory)
+        rescue Errno::EEXIST
+        end
+        FileUtils.touch "#{@directory}/#{@store}.yml"
+      end
+      
+      # Write the hash back to the yaml file
+      def save(hash)
+        File.open("#{@directory}/#{@store}.yml", 'w+') {|f| f.write(hash.to_yaml) }
+      end
+    end
+  end
+end

data/lib/mosaic/version.rb

@@ -0,0 +1,4 @@
+module Mosaic
+  # Mosaics Version Number
+  VERSION = "0.0.1pre"
+end

data/mosaic.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mosaic/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mosaic"
+  gem.version       = Mosaic::VERSION
+  gem.authors       = ["Adam \"Arcath\" Laycock"]
+  gem.email         = ["gems@arcath.net"]
+  gem.description   = %q{MOdular Sinatra ApplICation}
+  gem.summary       = %q{Simple and extensible sinatra powered application framework}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency "sinatra"
+  
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "yard"
+end

data/spec/module_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Mosaic::Module do
+  it "should accept 2 inputs" do
+    Mosaic::Module.new(DummyRequest.new, "/foo/bar")
+  end
+  
+  it "should put the path variable into params" do
+    responder = TestModule.new(DummyRequest.new("/foo/widget"), "/foo/:bar")
+    responder.params[:bar].should eq "widget"
+  end
+  
+  it "should have a response" do
+    TestModule.new(DummyRequest.new("/foo/widget"), "/foo/:bar").response.should be_a Mosaic::Response
+  end
+  
+  it "should have set respond to" do
+    # This should have been set when TestModule was declared
+    Mosaic.responders["/"].should be_a Array
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Mosaic::Response do
+  it "should assume some values" do
+    response = Mosaic::Response.new(DummyRequest.new)
+  end
+  
+  it "should use erb as the default view format" do
+    response = Mosaic::Response.new(DummyRequest.new)
+    response.view_format.should eq :erb
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require "bundler"
+
+Bundler.require
+
+class TestModule < Mosaic::Module
+  respond_to :get, "/"
+  respond_to :get, "/foo/:bar"
+end
+
+class DummyRequest
+  attr_reader :params, :path_info
+  
+  def initialize(path_info = "")
+    @params = {}
+    @path_info = path_info
+  end
+end

data/support/views/errors/error404.html.erb

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<title>Error 404</title>
+	<style type="text/css">
+	body{
+		font-family:helvetica;
+	}
+	h1{
+		margin:auto;
+		width:300px;
+		text-align:center;
+		color:red;
+		border-bottom:dashed red 1px;
+	}
+	h2{
+		margin:auto;
+		margin-top:10px;
+		width:300px;
+		text-align:center;
+	}
+	</style>
+</head>
+<body>
+	<h1>Error 404</h1>
+	<h2><%= @request.path_info%></h2>
+</body>
+</html>

data/support/views/info/index.html.erb

@@ -0,0 +1,17 @@
+<h1>Mosaic</h1>
+
+Application Root: <b><%= File.expand_path(Mosaic.root) %></b><br />
+Mosaic Version: <b><%= Mosaic::VERSION %></b><br />
+Sinatra Version: <b><%= Sinatra::VERSION %></b><br />
+Responders:
+<ul>
+	<% Mosaic.responders.keys.sort.reverse.each do |key|%>
+	<li><b><%= key %></b> - <%= Mosaic.responders[key].first.inspect %></li>
+	<% end %>
+</ul>
+Middleware:
+<ul>
+	<% Mosaic.middleware.each do |middleware| %>
+	<li><b><%= middleware.inspect %></b></li>
+	<% end %>
+</ul>

data/support/views/info/layout.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<title>Mosaic Info</title>
+	<style type="text/css">
+	body{
+		font-family:helvetica;
+		background-color:#9bf;
+		color:#444;
+	}
+	.container{
+		background-color:#fff;
+		width:600px;
+		margin:auto;
+		padding:10px;
+	}
+	</style>
+</head>
+<body>
+	<div class="container">
+		<%= yield %>
+	</div>
+</body>
+</html>

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: mosaic
+version: !ruby/object:Gem::Version
+  version: 0.0.1pre
+  prerelease: 5
+platform: ruby
+authors:
+- Adam "Arcath" Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MOdular Sinatra ApplICation
+email:
+- gems@arcath.net
+executables:
+- mosaic
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mosaic
+- lib/blank_app/Gemfile
+- lib/blank_app/app/modules/example.rb
+- lib/blank_app/config.ru
+- lib/blank_app/config/mosaic.rb
+- lib/blank_app/public/stylesheets/application.css
+- lib/blank_app/views/index.html.erb
+- lib/blank_app/views/layouts/application.html.erb
+- lib/mosaic.rb
+- lib/mosaic/application.rb
+- lib/mosaic/bin.rb
+- lib/mosaic/module.rb
+- lib/mosaic/modules/info.rb
+- lib/mosaic/modules/sass.rb
+- lib/mosaic/modules/static.rb
+- lib/mosaic/response.rb
+- lib/mosaic/stores/yaml.rb
+- lib/mosaic/version.rb
+- mosaic.gemspec
+- spec/module_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- support/views/errors/error404.html.erb
+- support/views/info/index.html.erb
+- support/views/info/layout.html.erb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple and extensible sinatra powered application framework
+test_files:
+- spec/module_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+has_rdoc: