rticles 0.1.0

data/lib/rticles/railtie.rb

@@ -0,0 +1,5 @@
+class Rticles::Railtie < Rails::Railtie
+  generators do
+    require 'rticles/generators/install_generator'
+  end
+end

data/lib/rticles/version.rb

@@ -0,0 +1,3 @@
+module Rticles
+  VERSION = "0.1.0"
+end

data/lib/tasks/rticles_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rticles do
+#   # Task goes here
+# end

data/rticles.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "rticles/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "rticles"
+  s.version     = Rticles::VERSION
+  s.authors     = ["Chris Mear"]
+  s.email       = ["getinvolved@oneclickorgs.com"]
+  s.homepage    = "https://github.com/oneclickorgs/rticles"
+  s.summary     = "Consistent editing for legal documents."
+  s.description = "Rticles is a Rails plugin that allows for web-based editing of legal documents. It lets you create nested, numbered paragraphs, along with intra-document references that remain accurate as paragraphs are inserted, removed and moved."
+
+  s.files       = `git ls-files`.split($\)
+
+  s.add_dependency "rails", "~> 3.2.8"
+  s.add_dependency "acts_as_list", "~>0.1.8"
+  s.add_dependency "roman-numerals", "~>0.3.0"
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "nokogiri"
+  s.add_development_dependency "equivalent-xml"
+end

data/spec/document_spec.rb

@@ -0,0 +1,193 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Rticles::Document do
+
+  include DocumentMacros
+
+  describe ".from_yaml" do
+    it "works with sub-paragraphs" do
+      yaml = File.open('spec/fixtures/simple.yml', 'r')
+      expect {
+        @document = Rticles::Document.from_yaml(yaml)
+      }.to change{Rticles::Paragraph.count}.by(4)
+      @document.outline(:with_index => true, :for_display => true).should == [
+        '1 Paragraph 1',
+        [
+          '1.1 Paragraph 1.1',
+          '1.2 Paragraph 1.2'
+        ],
+        '2 Paragraph 2'
+      ]
+    end
+
+    describe "headings" do
+      before(:each) do
+        yaml = File.open('spec/fixtures/ips.yml', 'r')
+        @document = Rticles::Document.from_yaml(yaml)
+        @document.save!
+      end
+
+      it "works with headings" do
+        @document.top_level_paragraphs.first.should be_heading
+      end
+
+      it "works with sub-headings" do
+        p = @document.top_level_paragraphs[20]
+        p.body.should eq "Borrowing from Members"
+        p.heading.should eq 2
+      end
+    end
+
+    describe "topics" do
+      before(:each) do
+        yaml = File.open('spec/fixtures/ips.yml', 'r')
+        @document = Rticles::Document.from_yaml(yaml)
+        @document.save!
+      end
+
+      it "saves the topics" do
+        objects_paragraph = Rticles::Paragraph.where(:topic => 'objects', :document_id => @document.id).first
+        objects_paragraph.should be_present
+        objects_paragraph.body.should == "The objects of the Co-operative shall be to carry on the business as a co-operative and to carry on any other trade, business or service and in particular to #rticles#objectives"
+      end
+    end
+  end
+
+  describe "customisations" do
+    before(:each) do
+      yaml = File.open('spec/fixtures/constitution.yml', 'r')
+      @document = Rticles::Document.from_yaml(yaml)
+      @document.save!
+    end
+
+    describe "insertion" do
+      it "is displayed" do
+        @document.insertions = {:organisation_name => "The One Click Orgs Association"}
+        @document.outline(:for_display => true)[0].should ==
+          "This is the constitution (\"Constitution\") of The One Click Orgs Association. (\"The Organisation\")"
+      end
+    end
+
+    describe "choice" do
+      it "is displayed" do
+        @document.choices = {:assets => true}
+        @document.outline(:for_display => true)[2].should ==
+          "The Organisation may hold, transfer and dispose of material assets and intangible assets."
+      end
+    end
+
+    it "customises the entire document" do
+      @document.insertions = {
+        :organisation_name => "The One Click Orgs Association",
+        :objectives => "developing OCO.",
+        :website => "http://gov.oneclickorgs.com/",
+        :voting_period => "3 days",
+        :general_voting_system_description => "Supporting Votes from more than half of the Members during the Voting Period; or when more Supporting Votes than Opposing Votes have been received for the Proposal at the end of the Voting Period.",
+        :constitution_voting_system_description => "Supporting Votes from more than half of the Members are received during the Voting Period; or when more Supporting Votes than Opposing Votes have been received for the Proposal at the end of the Voting Period.",
+        :membership_voting_system_description => "Supporting Votes are received from more than two thirds of Members during the Voting Period."
+      }
+      @document.choices = {
+        :assets => true
+      }
+      @document.outline(:for_display => true).should == [
+        "This is the constitution (\"Constitution\") of The One Click Orgs Association. (\"The Organisation\")",
+        "The Organisation has the objectives of developing OCO. (\"Objectives\")",
+        "The Organisation may hold, transfer and dispose of material assets and intangible assets.",
+        "The Organisation uses an electronic system to carry out its governance (\"Governance System\").",
+        "The Organisation has one or more members (\"Members\") who support its Objectives.",
+        "Each Member nominates an email address at which they will receive important notices from the Organisation (\"Nominated Email Address\").",
+        "Members may access the Governance System at the website http://gov.oneclickorgs.com/.",
+        "Members may view the current Constitution on the Governance System.",
+        "Members may view a register of current Members together with their Nominated Email Addresses on the Governance System.",
+        "Members may resign their membership via the Governance System.",
+        "Members may jointly make a decision (\"Decision\") relating to any aspect of the Organisation's activities as follows:",
+        [
+          "Any member may submit a proposal (\"Proposal\") on the Governance System.",
+          "A Proposal may be voted on for a period of 3 days starting with its submission (\"Voting Period\").",
+          "Members may view all current Proposals on the Governance System.",
+          "Members may vote to support (\"Supporting Vote\") or vote to oppose (\"Opposing Vote\") a Proposal on the Governance System during the Proposal's Voting Period.",
+          "Members may only vote on Proposals submitted during their membership of the Organisation.",
+          "A Decision is made if a Proposal receives Supporting Votes from more than half of the Members during the Voting Period; or when more Supporting Votes than Opposing Votes have been received for the Proposal at the end of the Voting Period.",
+          "except that:",
+          [
+            "The Constitution may only be amended by a Decision where Supporting Votes from more than half of the Members are received during the Voting Period; or when more Supporting Votes than Opposing Votes have been received for the Proposal at the end of the Voting Period."
+          ],
+          "and",
+          [
+            "New Members may be appointed (and existing Members ejected) only by a Decision where Supporting Votes are received from more than two thirds of Members during the Voting Period."
+          ]
+        ],
+        "Members may view all Decisions on the Governance System."
+      ]
+    end
+  end
+
+  describe "topic lookup" do
+    it "takes into account the current choices" do
+      @document = Rticles::Document.create
+      @document.top_level_paragraphs.create(:body => "First rule.")
+      @document.top_level_paragraphs.create(:body => "#rticles#true#single_shareholding Members may only hold a single share.", :topic => 'shares')
+      @document.top_level_paragraphs.create(:body => "#rticles#false#single_shareholding Members may only multiple shares.", :topic => 'shares')
+      @document.top_level_paragraphs.create(:body => "#rticles#false#single_shareholding Shares may be applied for and withdrawn at any time", :topic => 'shares')
+      @document.top_level_paragraphs.create(:body => "Some other rule.")
+      @document.top_level_paragraphs.create(:body => "The company must keep a record of shareholdings.", :topic => 'shares')
+
+      @document.choices[:single_shareholding] = true
+      @document.paragraph_numbers_for_topic('shares', true).should eq "2, 4"
+
+      @document.choices[:single_shareholding] = false
+      @document.paragraph_numbers_for_topic('shares', true).should eq "2–3, 5"
+    end
+
+    it "works for a complex document" do
+      yaml = File.open('spec/fixtures/ips.yml', 'r')
+      @document = Rticles::Document.from_yaml(yaml)
+
+      @document.choices[:single_shareholding] = true
+      @document.paragraph_numbers_for_topic('shares', true).should eq "32"
+
+      @document.choices[:single_shareholding] = false
+      @document.paragraph_numbers_for_topic('shares', true).should eq "35–40"
+    end
+  end
+
+  describe "numbering config" do
+    before(:each) do
+      stub_outline([:one, [:sub_one, :sub_two, [:sub_sub_one, :sub_sub_two, :sub_sub_three], :sub_three], :two])
+      @paragraph = @document.paragraphs.where(:body => :sub_sub_three).first
+    end
+
+    it "defaults to full decimal numbering" do
+      @paragraph.full_index.should eq "1.2.3"
+    end
+
+    it "allows customisation of the separator" do
+      @document.numbering_config.separator = ' '
+      @paragraph.full_index(true, nil, @document.numbering_config).should eq "1 2 3"
+    end
+
+    it "allows customisation of the list style type" do
+      @document.numbering_config[1].style = Rticles::Numbering::DECIMAL
+      @document.numbering_config[2].style = Rticles::Numbering::LOWER_ALPHA
+      @document.numbering_config[3].style = Rticles::Numbering::LOWER_ROMAN
+
+      @paragraph.full_index(true, nil, @document.numbering_config).should eq "1.b.iii"
+    end
+
+    it "allows customisation of the number format" do
+      @document.numbering_config.separator = ' '
+
+      @document.numbering_config[2].format = '(#)'
+
+      @paragraph.full_index(true, nil, @document.numbering_config).should eq "1 (2) 3"
+    end
+
+    it "allows setting only the innermost number should be printed" do
+      @document.numbering_config.innermost_only = true
+      @paragraph.full_index(true, nil, @document.numbering_config).should eq "3"
+    end
+  end
+
+end

data/spec/dummy/.gitignore

@@ -0,0 +1,6 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/**/*
+doc/app/*
+.sass-cache

data/spec/dummy/.rspec

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

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.