jagger 0.0.1

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+source 'http://rubygems.org'
+gemspec
+
+gem 'sprockets'
+gem 'sinatra'
+gem 'rack'
+gem 'rake'
+
+group :development do
+  gem 'rspec'
+  gem 'mocha'
+  gem 'rack-test'
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    jagger (0.0.1)
+      rack
+      sinatra
+      sprockets
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    hike (1.2.1)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.2.0)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    sprockets (2.4.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jagger!
+  mocha
+  rack
+  rack-test
+  rake
+  rspec
+  sinatra
+  sprockets

data/README.md

@@ -0,0 +1,104 @@
+# Jagger is your frontman!
+
+![Mick Jagger](http://i.imgur.com/xW8XW.jpg)
+
+Jagger is a frontman for your frontend application. Mixing frontend and
+backend in one Rails applicaiton sucks, let's say it stright! We have
+bunch of unrelated things mixed together, why? With Jagger you gonna
+rock your frontend application management!
+
+## Philosophy
+
+Backend and frontend of web application are in fact two different 
+applications, ususaly utilizing different languages and tools.
+The main point of Jagger's philosophy is to split backend and
+frontend into separated applications.
+
+**Frontend** - ususally a JavaScript (eg. Backbone) application 
+with set of templates and GUI integration tests.
+
+**Backend** - an app written with Sinatra, Rails or whatever else,
+which provices an unified API required by the _Frontend_ app.
+
+## Controversy
+
+_Are you insane? I have to write two apps instead of one, and everytime
+I change something in the backend then I have to adjust frontend one?_
+
+Um... Well, you do the same every single day. You change something in
+your Rails model, then you going to the view and editing it, then you
+going to the (Java|Coffee)Script part and keep adjusting to the changes
+you made in the model.
+
+**The biggest advantages of this layout**:
+
+* Frontend people can work on frontend without dealing with overwhelming
+  backend code.
+* Backend people may don't give a shit about frontend stuff.
+* Application has unified API which can be reused further by other
+  views (iPhone or Android app, external consumers, etc.)
+* Frontend may be written totally without thinking about the databases
+  and other delivery methods. It can focus only on the look and feel
+  by accessing all the data from mocks.
+* It's briliant for the designers, thus they don't need to install all
+  the development stuff (usually, you have to install it for them).
+* After all, you can serve everything as one application anyway...
+
+**This layout also have disadvantages**:
+
+* It has no server side generated views - so it is not well suitable
+  for the applications which tend to be crawlable eg. by Googlebot.
+* It requires good communication in your team in case of defining
+  and maintaining the API. Hmm, if you improve your communication thanks
+  to this then it may be considered as an advantage.
+* It forces you to think different and abstract... some people don't like
+  this :P
+
+## Installation
+
+Like always, via rubygems:
+
+    $ gem install jagger
+    
+Or by adding dependency to your gemfile:
+
+    gem 'jagger'
+    
+## Usage
+
+Jagger comes with set of conventions to make your life easier. Here's
+the frontend app directory structure:
+
+    + your_frontend/
+    |-- lib/                - External, static JavaScript libraries (eg. jQuery).
+    |-+ src/                - Dynamic sources.
+    | |-- styles/           - Your CSS, SASS, LESS or God knows what styles.
+    | |-- sprites/          - Source images for your sprites.
+    | |-- main/             - Your application's (Java|Coffee)Script files.
+    | |-- test/             - Your GUI test files (i.a. QUnit, Selenium).
+    |-- static/             - Static images, javascripts, fonts, etc.
+    |-- templates/          - All the template files.
+    |-- config.ru           - Rack configuration.
+
+You can set ther up a Gemfile with `jagger` listed as a dependency and
+add this code to `config.ru`
+
+    # *snip*
+
+    run Jagger::Builder.new
+    
+If you want to mount it within your backend application, no problem!
+You can do it this way:
+
+    # *snip*
+    
+    map '/api' do
+      run MyBackendApp.new
+    end
+    
+    map '/' do
+      run Jagger::Builder.new
+    end
+
+You can serve your frontend app simply like any other rack app using
+`thin`, `rackup` or whatever you want. 

data/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ENV['RSPEC_OPTS']
+end
+
+task :test => :spec
+task :default => :test
+
+desc "Opens console with loaded env."
+task :console do
+  $LOAD_PATH.unshift("./lib")
+  require 'jagger'
+  require 'irb'
+  ARGV.clear
+  IRB.start
+end

data/jagger.gemspec

@@ -0,0 +1,27 @@
+# -*- ruby -*-
+
+Gem::Specification.new do |s|
+  s.name              = 'jagger'
+  s.rubyforge_project = 'jagger'
+  s.version           = '0.0.1'
+
+  s.authors           = ['Chris Kowalik']
+  s.email             = ['chris@nu7hat.ch']
+  s.homepage          = 'http://github.com/nu7hatch/jagger'
+  s.summary           = 'Jagger is your frontman!'
+  s.description       = <<-END
+Jagger an frontman for your applications. It serves dynamically 
+generated assets via sprockets pipeline, static files and all the 
+templates. All that makes your life much easier.'
+END
+
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths     = ['lib']
+
+  s.add_dependency 'sprockets'
+  s.add_dependency 'sinatra'
+  s.add_dependency 'rack'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'mocha'
+end

data/lib/jagger.rb

@@ -0,0 +1,3 @@
+require 'jagger/assets'
+require 'jagger/app'
+require 'jagger/builder'

data/lib/jagger/app.rb

@@ -0,0 +1,24 @@
+require 'sinatra/base'
+
+module Jagger
+  # Internal: App is a Sinatra application used to serve static
+  # files and index, and to keep Jagger's configuration. 
+  class App < Sinatra::Application
+    set :asset_paths, %w(src/main/ src/test/ src/look/ lib/)
+    set :public_folder, 'static'
+    set :views, 'templates'
+    set :layout, false
+
+    helpers do
+      # Public: Returns whether requests' mocks should be skipped
+      # or not. 
+      def mock_requests?
+        ENV['USE_REAL_REQUESTS'].to_i == 0
+      end
+    end
+
+    get '/' do
+      erb :index
+    end
+  end
+end

data/lib/jagger/assets.rb

@@ -0,0 +1,29 @@
+require 'sprockets'
+
+module Jagger
+  # Internal: Assets serves all dynamically generated asssets 
+  # through sprockets pipeline.
+  class Assets
+    # Public: Constructor. Initializes sprockets environment.
+    def initialize
+      @sprockets = Sprockets::Environment.new
+    end
+
+    # Public: Registers given load paths in sprockets' env.
+    #
+    # dir - The Array of dirs to register
+    #
+    def append_paths(dirs = [])
+      dirs.each { |dir| @sprockets.append_path(dir) }
+    end
+
+    # Public: Serves assets
+    #
+    # env - The Hash HTTP environment.
+    #
+    # Returns HTTP response data.
+    def call(env)
+      @sprockets.call(env)
+    end
+  end
+end

data/lib/jagger/builder.rb

@@ -0,0 +1,53 @@
+module Jagger
+  # Public: Builder creates rack compatible application which gathers
+  # and serves static sinatra app and sprockets pipeline together.
+  #
+  # Example
+  #
+  #   app = Jagger::Builder.new do
+  #     set :asset_paths, %w(src/main/ src/test/ src/look/ lib/)
+  #     set :views, 'templates'
+  #     set :public_folder, 'static'
+  #   end
+  #
+  #   run app
+  #
+  # Configuration above is the default one, so in most of cases only
+  # the following declaration will be enough:
+  #
+  #   run Jagger::Builder.new
+  #
+  class Builder
+    # Public: Constructor. Initializes application and the assets 
+    # pipeline. Passed block accepts custom configuration.
+    def initialize(&block)
+      app.instance_eval(&block) if block_given?
+      assets.append_paths(app.asset_paths)
+    end
+
+    # Internal: Sinatra application used to serve static files and
+    # index page.
+    def app
+      @app ||= App
+    end
+    
+    # Internal: Assets pipeline environment.
+    def assets
+      @assets ||= Assets.new
+    end
+
+    # Public: Serves the application and assets pipeline together
+    # as one rack application.
+    #
+    # env - The Hash with request environment.
+    #
+    def call(env)
+      map = {
+        '/assets' => assets,
+        '/'       => app.new,
+      }
+      router = Rack::URLMap.new(map)
+      router.call(env)
+    end
+  end
+end

data/spec/app_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Jagger::App do
+  describe "#mock_requests?" do
+    it "returns true when requests should be mocked" do
+      #ENV['USE_REAL_REQUESTS'] = '0'
+      #subject.should be_mock_requests
+    end
+
+    it "returns false when requests should not be mocked" do
+      #ENV['USE_REAL_REQUESTS'] = '1'
+      #subject.should_not be_mock_requests
+    end
+  end
+
+  it "has proper default configuration" do
+    app = Jagger::App
+    app.asset_paths == %w(src/main/ src/test/ src/look/ lib/)
+    app.public_folder.should == 'static'
+    app.views.should == 'templates'
+    app.layout.should_not be
+  end
+
+  describe "integration" do
+    let :app do
+      base = Class.new(Jagger::App)
+      base.set :views, File.expand_path('../fixtures/templates/', __FILE__)
+      base.new
+    end
+    
+    it "serves index page" do
+      get '/'
+      last_response.body.should == 'Hello Jagger!'
+    end
+  end
+end

data/spec/assets_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Jagger::Assets do
+  describe "#append_paths" do
+    it "registers specified paths under the sprockets instance" do
+      Sprockets::Environment.any_instance.tap do |env|
+        env.expects(:append_path).with('foo/')
+        env.expects(:append_path).with('bar/')
+      end
+      subject.append_paths(%w(foo/ bar/))
+    end
+  end
+
+  describe "#call" do
+    it "serves assets via sprockets pipeline" do
+      env = { :hello => 'world' }
+      Sprockets::Environment.any_instance.expects(:call).with(env)
+      subject.call(env)
+    end
+  end
+end

data/spec/builder_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Jagger::Builder do
+  describe "initialization" do
+    it "configures sinatra app" do
+      app = Jagger::Builder.new { set :public_folder, 'test' }
+      app.app.public_folder.should == 'test'
+    end
+
+    it "registers assets paths" do
+      paths = %w(test/)
+      Jagger::Assets.any_instance.expects(:append_paths).with(paths)
+      app = Jagger::Builder.new { set :asset_paths, paths }
+    end
+  end
+
+  describe "integration" do
+    let :app do
+      Jagger::Builder.new do
+        set :asset_paths, [File.expand_path('../fixtures/src/', __FILE__)]
+        set :views, File.expand_path('../fixtures/templates/', __FILE__)
+      end
+    end
+
+    it "serves index page" do
+      get '/'
+      last_response.body.should == 'Hello Jagger!'
+    end
+
+    it "serves assets" do
+      get '/assets/one.js'
+      last_response.body.strip.should == "alert('hello!');"
+    end
+  end
+end

data/spec/fixtures/src/one.js

@@ -0,0 +1 @@
+//= require two

data/spec/fixtures/src/two.js

@@ -0,0 +1 @@
+alert('hello!');

data/spec/fixtures/templates/index.erb

@@ -0,0 +1 @@
+Hello Jagger!

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'mocha'
+require 'rack/test'
+
+require 'jagger'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: jagger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Kowalik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: &19515340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19515340
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &19514380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19514380
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &19513580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19513580
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &19512840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19512840
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &19510360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19510360
+description: ! "Jagger an frontman for your applications. It serves dynamically \ngenerated
+  assets via sprockets pipeline, static files and all the \ntemplates. All that makes
+  your life much easier.'\n"
+email:
+- chris@nu7hat.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- jagger.gemspec
+- lib/jagger.rb
+- lib/jagger/app.rb
+- lib/jagger/assets.rb
+- lib/jagger/builder.rb
+- spec/app_spec.rb
+- spec/assets_spec.rb
+- spec/builder_spec.rb
+- spec/fixtures/src/one.js
+- spec/fixtures/src/two.js
+- spec/fixtures/templates/index.erb
+- spec/spec_helper.rb
+homepage: http://github.com/nu7hatch/jagger
+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: '0'
+requirements: []
+rubyforge_project: jagger
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Jagger is your frontman!
+test_files: []