confluence 0.2.0 → 1.0.0

data/spec/confluence/railtie_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Confluence::Rails::Railtie do 
+  it "should have been properly initialized with rails startup" do
+    WelcomeController.view_paths.should include Confluence::Railties::Resolver.instance
+  end
+end

data/spec/confluence/railties/resolver_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+describe Confluence::Railties::Resolver do 
+  context "resolving from gem" do
+    let(:resolver) { Confluence::Railties::Resolver.instance  }
+    let(:ctrl) { WelcomeController.append_view_path(resolver); WelcomeController.new }
+    describe "#find_templates" do
+
+      context "nil result" do
+        it "should return with an empty array when given stuff it can't find" do
+          resolver.find_templates("dog", "cat/rat/bird", false, {}).should be_empty
+        end
+        it "should return with an empty array when given stuff it can't find" do
+          resolver.find_templates("dog", "cat/rat/bird", true, {}).should be_empty
+        end
+      end
+
+      context "good results" do
+        let(:templates) { resolver.find_templates("header_navigation", "header_navigation", true, {}) }
+        it "should return the template that corresponds to the template in the header_navigation gem" do
+          templates.should be_a Array
+          templates.each { |template| template.should be_a ActionView::Template }
+        end
+      end
+
+    end
+
+    describe "#_get_gem_directory" do
+      let(:get) { lambda { |parameter| resolver.send("_get_gem_directory", parameter) } }
+
+      context "simple usage" do
+        let(:path) { get.call("header_navigation") }
+        it "should get me the path to the header_navigation gem on my machine if I use the prefix as header_navigation" do
+          path.should eq File.join(Gem.loaded_specs["header_navigation"].full_gem_path, "assets", "html")
+          path.should =~ /gem/
+          path.should =~ /ruby/
+          path.should be_a String
+        end
+      end
+
+      context "expected usage" do
+        let(:path) { get.call "header_navigation/cat/dog/fag/rat/123048/asdf/fajk" }
+
+        it "should thoroughly ignore the rest of the crap after header_navigation since that is all it needs to find existing gems" do
+          path.should eq File.join(Gem.loaded_specs["header_navigation"].full_gem_path, "assets", "html", "cat","dog","fag","rat","123048","asdf","fajk")
+          path.should =~ /gem/
+          path.should =~ /ruby/
+          path.should be_a String
+        end
+      end
+
+      context "dumbfuckery" do
+        let(:path) { get.call "lolwtfasjkdflaskdjflaskjdf/ajsfk/asjdfkl/asdf" }
+        it "should return nil if no such gem exists" do 
+          path.should be_nil
+        end
+
+        it "should properly deal with nil paths" do
+          get.call(nil).should be_nil
+          get.call("").should be_nil
+        end
+      end
+    end
+
+    describe "#_get_partial_path" do
+      let(:get) { lambda { |name, path| resolver.send("_get_partial_path", name, path) } }
+
+      context "simple usage" do
+        let(:path) { get.call "header_navigation",  resolver.send("_get_gem_directory", "header_navigation") }
+
+        it "should produce the fully qualified path to the partial of interest" do
+          File.exist?(path + ".html.haml").should be_true
+          path.should be_a String
+          path.should =~ /assets/
+          path.should =~ /html/
+        end
+      end
+
+      context "complex usage" do
+        let(:path) { get.call "link",  resolver.send("_get_gem_directory", "header_navigation/header_navigation") }
+
+        it "should produce the fully qualified path to partials that are embedded in folders that are several layers down" do
+          File.exist?(path + ".html.haml").should be_true
+          path.should be_a String
+          path.should =~ /assets/
+          path.should =~ /html/
+        end
+      end
+
+      context "dumbfuckery" do
+        let(:path) { get.call "link",  nil }
+        it "should propagte the nil" do
+          path.should be_nil
+          get.call(nil, nil).should be_nil
+          get.call(nil, "23").should be_nil
+        end
+      end
+    end
+
+    describe "#_get_handler_from_nothing" do
+      let(:handler) { lambda { resolver.send("_get_handler_from_nothing") } }
+
+      it "should return the haml handler since that's the only one I'm interested in supporting right now" do
+        handler.call.should eq Haml::Plugin
+      end
+    end
+
+    describe "#_get_source_from_path" do
+      let(:get) { lambda { |path| resolver.send("_get_source_from_path", path) } }
+
+      context "simple usage" do
+        let(:source) { get.call resolver.send("_get_partial_path", "header_navigation", resolver.send("_get_gem_directory", "header_navigation") ) }
+
+        it "should be a string" do
+          source.should be_a String
+          source.length.should > 25
+          source.should =~ /\.header-navigation-box/
+          source.should =~ /= render/
+        end
+      end
+
+      context "complex usage" do
+        let(:source) { get.call resolver.send("_get_partial_path", "link", resolver.send("_get_gem_directory", "header_navigation/header_navigation") ) }
+
+        it "should be a string" do
+          source.should be_a String
+          source.length.should > 10
+          source.should =~ /%li/
+          source.should =~ /= link_to/
+        end
+      end
+
+      context "dumbfuckery" do
+        it "should return nil" do
+          get.call(nil).should be_nil
+        end
+      end
+    end
+
+    describe "#_get_identifier" do
+      let(:get) { lambda { |name, prefix| resolver.send("_get_identifier", name, prefix) } }
+      let(:generator) { lambda { (1..rand(12)).to_a.map { ("a".."z").to_a.push(" ")[rand(27)] } } }
+      it "should guarentee uniqueness if the given name and prefix are unique" do
+        @container = {
+          get.call("dog", "cat") => "dog-cat"
+        }
+        @temp = ["dog", "cat"]
+        500.times do
+          name = @temp.shift || generator.call
+          prefix = @temp.shift || generator.call
+          if @container[get.call(name, prefix)].nil?
+            @container[get.call(name, prefix)] = "#{name}-#{prefix}"
+          else
+            @container[get.call(name, prefix)].should eq "#{name}-#{prefix}"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/confluence/welcome_controller_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe WelcomeController do
+  let(:api) do 
+    WelcomeController.new
+  end
+  context "sanity" do
+
+    describe "#render_to_string" do
+      let(:response) { api.render_to_string( "welcome/index" ) }
+
+      it "should be okay" do
+        expect { response }.to raise_error ActionView::Template::Error
+      end
+
+    end
+  end
+
+  context "usage" do
+    let(:presenter) do
+      HeaderNavigation::Presenter.from_nothing
+    end
+
+    describe "#render_to_string" do
+      let(:response) { api.render_to_string :partial => "header_navigation/header_navigation", :locals => {:presenter => presenter} }
+
+      it "should've rendered the view partial as per my demands" do
+        expect { response }.not_to raise_error
+        response.should be_a String
+        response.should =~ /<ul class='nav'/
+        response.should =~ /<a href/
+      end
+    end
+  end
+  
+
+end

data/spec/confluence_spec.rb

@@ -17,11 +17,24 @@ describe Confluence do
 
     context "instance" do
       let(:app) { Confluence::Application.start ["new", "assfag"] }
-
+      let(:cleaner) do 
+        Class.new do 
+          def clean(path)
+            FileUtils::rm_rf(path)
+          end
+        end.new
+      end
       describe "#new" do
+        before :each do
+          @project_path = File.expand_path("../assfag", File.dirname(__FILE__))
+        end 
         it "should create the application that I demand it to" do
           app
-          fail "Until this becomes an automated process, YOU need to go and delete the test folder yourself"
+          File.exists?(@project_path).should be_true
+        end
+
+        after(:each) do
+          cleaner.clean(@project_path) if File.exists?(@project_path)
         end
       end
     end

data/spec/fixture/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/fixture/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.