dossier 2.0.0

data/spec/dossier/configuration_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Dossier::Configuration do
+
+  before :each do 
+    Dossier.configure
+    @config = Dossier.configuration
+  end
+
+  describe "defaults" do
+    it "uses the rails configuration directory for the config path" do
+      @config.config_path.should eq(Rails.root.join("config", "dossier.yml"))
+    end
+  end
+
+  describe "client" do
+    it "uses config/dossier.yml to setup the client" do
+      options = YAML.load_file(Rails.root.join('config', 'dossier.yml'))[Rails.env].symbolize_keys
+      Dossier::Client.should_receive(:new).with(options)
+      Dossier.configure
+    end
+
+    it "will raise an exception if config/dossier.yml cannot be read" do
+      config_path = Rails.root.join('config')
+      FileUtils.mv config_path.join('dossier.yml'), config_path.join('dossier.yml.test')
+      expect { Dossier.configure }.to raise_error(Dossier::ConfigurationMissingError)
+      FileUtils.mv config_path.join('dossier.yml.test'), config_path.join('dossier.yml')
+    end
+
+    it "will setup the connection options" do
+      @config.connection_options.should be_a(Hash)
+    end
+  end
+
+end

data/spec/dossier/formatter_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Dossier::Formatter do
+
+  let(:formatter) { described_class }
+
+  describe "methods from ActionView::Helpers::NumberHelper" do
+
+    it "formats numbers with commas" do
+      expect(formatter.number_with_delimiter(1025125)).to eq('1,025,125')
+    end
+
+    it "formats as U.S. dollars" do
+      expect(formatter.number_to_currency(1025)).to eq('$1,025.00')
+    end
+
+  end
+
+  it "formats as U.S. dollars from cents" do
+    expect(formatter.number_to_currency_from_cents(102500)).to eq('$1,025.00')
+  end
+
+  describe "route formatting" do
+    let(:route) { {controller: :site, action: :index} }
+
+    it "allows URL generation" do
+      expect(formatter.url_for(route)).to eq('/woo')
+    end
+
+    it "allows link generation" do
+      expect(formatter.link_to('Woo!', route)).to eq('<a href="/woo">Woo!</a>')
+    end
+
+    it "allows usage of url helpers" do
+      expect(formatter.url_helpers.woo_path).to eq('/woo')
+    end
+  end
+
+end

data/spec/dossier/query_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Dossier::Query do
+
+  let(:report) { TestReport.new(:foo => 'bar') }
+  let(:query)  { Dossier::Query.new(report) }
+
+  before :each do
+    report.stub(:salary).and_return(2)
+    report.stub(:ids).and_return([1,2,3])
+  end
+
+  describe "replacing symbols by calling methods of the same name" do
+
+    context "when the methods return single values" do
+
+      before :each do
+        report.stub(:sql).and_return("SELECT * FROM employees WHERE id = :id OR girth < :girth OR name = :name")
+        report.stub(:id).and_return(92)
+        report.stub(:girth).and_return(3.14)
+        report.stub(:name).and_return('Jimmy')
+      end
+
+      it "escapes the values" do
+        query.should_receive(:escape).with(92)
+        query.should_receive(:escape).with(3.14)
+        query.should_receive(:escape).with('Jimmy')
+        query.to_s
+      end
+
+      it "inserts the values" do
+        expect(query.to_s).to eq("SELECT * FROM employees WHERE id = 92 OR girth < 3.14 OR name = 'Jimmy'")
+      end
+
+    end
+
+    context "when the methods return arrays" do
+
+      before :each do
+        report.stub(:sql).and_return("SELECT * FROM employees WHERE stuff IN :stuff")
+        report.stub(:stuff).and_return([38, 'blue', 'mandible', 2])
+      end
+
+      it "escapes each value in the array" do
+        Dossier.client.should_receive(:escape).with(38)
+        Dossier.client.should_receive(:escape).with('blue')
+        Dossier.client.should_receive(:escape).with('mandible')
+        Dossier.client.should_receive(:escape).with(2)
+        query.to_s
+      end
+
+      it "joins the return values with commas" do
+        expect(query.to_s).to eq("SELECT * FROM employees WHERE stuff IN (38, 'blue', 'mandible', 2)")
+      end
+
+    end
+
+  end
+end

data/spec/dossier/report_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Dossier::Report do
+
+  let(:report) { TestReport.new(:foo => 'bar') }
+
+  describe "report instances" do
+    it "takes options when initializing" do
+      report = TestReport.new(:foo => 'bar')
+      report.options.should eq('foo' => 'bar')
+    end
+  end
+
+  describe "callbacks" do
+
+    let(:report) do
+      Class.new(Dossier::Report) do
+        set_callback :build_query, :before, :before_test_for_build_query
+        set_callback :execute, :after, :after_test_for_execute
+
+        def sql; ''; end
+      end.new
+    end
+
+    it "has callbacks for build_query" do
+      report.should_receive(:before_test_for_build_query)
+      report.query
+    end
+
+    it "has callbacks for execute" do
+      Dossier.client.stub(:execute).and_return([])
+      report.stub(:before_test_for_build_query)
+      report.should_receive(:after_test_for_execute)
+      report.run
+    end
+
+  end
+
+  it "requires you to override the query method" do
+    expect {report.sql}.to raise_error(NotImplementedError)
+  end
+
+  describe "DSL" do
+
+    describe "run" do
+      it "will execute the generated sql query" do
+        report = EmployeeReport.new
+        Dossier.client.should_receive(:execute).with(report.query, 'EmployeeReport').and_return([])
+        report.run
+      end
+
+      it "will cache the results of the run in `results`" do
+        report = EmployeeReport.new
+        report.run
+        report.results.should_not be_nil
+      end
+    end
+
+    describe "view" do
+      it "will infer its view name from the class name" do
+        EmployeeReport.new.view.should eq("employee")
+      end
+    end
+
+  end
+
+end

data/spec/dossier/result_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe Dossier::Result do
+
+  module EachStubber
+    def each
+      adapter_results.rows.each do |row|
+        yield row
+      end
+    end
+  end
+
+  let(:report)         { TestReport.new }
+  let(:result_row)     { {'mascot' => 'platapus', 'cheese' => 'bleu'} }
+  let(:adapter_result) { double(:adapter_result, rows: [result_row.values], headers: result_row.keys) }
+  let(:result)         { Dossier::Result.new(adapter_result, report).tap { |r| r.extend(EachStubber) } }
+
+  describe "initialization with an adapter result object" do
+
+    it "will raise if the object isn't given" do
+      expect {Dossier::Result.new}.to raise_error(ArgumentError)
+    end
+
+    it "can extract the fields queried" do
+      adapter_result.should_receive(:headers).and_return([])
+      result.headers
+    end
+
+    it "can extract the values from the adapter results" do
+      result.should_receive(:to_a)
+      result.rows
+    end
+
+    describe "structure" do
+
+      it "can return an array of hashes" do
+        expect(result.hashes).to eq([result_row])
+      end
+
+      it "can return an array of arrays" do
+        result.stub(:headers).and_return(%w[mascot cheese])
+        expect(result.arrays).to eq([%w[mascot cheese], %w[platapus bleu]])
+      end
+
+    end
+
+  end
+
+  describe "subclasses" do
+
+    describe Dossier::Result::Formatted do
+
+      let(:result) { Dossier::Result::Formatted.new(adapter_result, report) }
+
+      describe "each" do
+
+        it "calls :each on on its adapter's results" do
+          adapter_result.rows.should_receive(:each)
+          result.each { |result| }
+        end
+
+        it "formats each of the adapter's results" do
+          result.should_receive(:format).with(result_row.values)
+          result.each { |result| }
+        end
+
+      end
+
+      describe "format" do
+
+        it "it raises unless its argument responds to :[]" do
+          expect {result.format(Object.new)}.to raise_error(ArgumentError)
+        end
+
+      end
+
+      describe "footer" do
+        let(:report) { TestReport.new(footer: 3) }
+        let(:adapter_result_rows) { 7.times.map { result_row.values } }
+
+        before :each do
+          adapter_result.stub(:rows).and_return(adapter_result_rows)
+        end
+
+        it "has 4 result rows" do
+          expect(result.body.count).to eq(4)
+        end
+
+        it "has 3 footer rows" do
+          expect(result.footers.count).to eq(3)
+        end
+
+      end
+
+    end
+
+    describe Dossier::Result::Unformatted do
+
+      let(:result) { Dossier::Result::Unformatted.new(adapter_result, report) }
+
+      describe "each" do
+
+        it "calls :each on on its adapter's results" do
+          adapter_result.rows.should_receive(:each)
+          result.each { |result| }
+        end
+
+        it "does not format the results" do
+          result.should_not_receive(:format)
+          result.each { |result| }
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/dossier_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Dossier do
+  it "is a module" do
+    Dossier.should be_a(Module)
+  end
+
+  it "is configuraable"  do
+    Dossier.configure
+    Dossier.configuration.should_not be_nil
+  end
+
+  it "has a configuration" do
+    Dossier.configure
+    Dossier.configuration.should be_a(Dossier::Configuration)
+  end
+
+  it "allows configuration via a block" do
+    @mysql_client = Mysql2::Client.new
+    Dossier.configure do |config|
+      config.client = @mysql_client
+    end
+    Dossier.configuration.client.should eq(@mysql_client)
+  end
+
+  it "exposes the configurations client via Dossier.client" do
+    Dossier.configure
+    Dossier.configuration.should_receive(:client)
+    Dossier.client
+  end
+end

data/spec/dummy/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.