rticles 0.1.0

data/spec/fixtures/simple.yml

@@ -0,0 +1,5 @@
+---
+- Paragraph 1
+- - Paragraph 1.1
+- - Paragraph 1.2
+- Paragraph 2

data/spec/paragraph_spec.rb

@@ -0,0 +1,251 @@
+require 'spec_helper'
+
+describe Rticles::Paragraph do
+  include DocumentMacros
+
+  describe "top-level positioning" do
+    before(:each) do
+      @document = Rticles::Document.create
+    end
+
+    it "is assigned correctly when pushing paragraphs to a document" do
+      paragraphs = Array.new(4){Rticles::Paragraph.new}
+      paragraphs.each{|p| @document.top_level_paragraphs.push(p)}
+      @document.save
+      @document.reload
+      @document.top_level_paragraphs.map(&:position).should == [1, 2, 3, 4]
+    end
+  end
+
+  describe "child paragraphs" do
+    before(:each) do
+      @document = Rticles::Document.create
+      @paragraph = @document.top_level_paragraphs.create
+    end
+
+    it "are assigned parentage when pushing child paragraphs to a parent paragraph" do
+      child = Rticles::Paragraph.new
+      @paragraph.children.push(child)
+      child.reload
+      child.parent_id.should == @paragraph.id
+    end
+
+    it "are associated with their parent's document" do
+      child = Rticles::Paragraph.new
+      @paragraph.children.push(child)
+      child.reload
+      child.document_id.should == @document.id
+    end
+  end
+
+  describe "inserting paragraphs" do
+    before(:each) do
+      @document = Rticles::Document.create
+      3.times{|i| @document.top_level_paragraphs.create(:body => "Originally #{i + 1}")}
+    end
+
+    it "inserts a paragraph at the top" do
+      paragraph = @document.paragraphs.build(:body => "New", :before_id => @document.top_level_paragraphs.first.id)
+      paragraph.save!
+      @document.reload
+      @document.top_level_paragraphs.map{|p| [p.parent_id, p.position, p.body]}.should == [
+        [nil, 1, "New"],
+        [nil, 2, "Originally 1"],
+        [nil, 3, "Originally 2"],
+        [nil, 4, "Originally 3"]
+      ]
+    end
+
+    it "inserts a paragraph at the bottom" do
+      paragraph = @document.paragraphs.build(:body => "New", :after_id => @document.top_level_paragraphs.last.id)
+      paragraph.save!
+      @document.reload
+      @document.top_level_paragraphs.map{|p| [p.parent_id, p.position, p.body]}.should == [
+        [nil, 1, "Originally 1"],
+        [nil, 2, "Originally 2"],
+        [nil, 3, "Originally 3"],
+        [nil, 4, "New"]
+      ]
+    end
+
+    it "inserts a paragraph in the middle" do
+      paragraph = @document.paragraphs.build(:body => "New", :before_id => @document.top_level_paragraphs[1].id)
+      paragraph.save!
+      @document.reload
+      @document.top_level_paragraphs.map{|p| [p.parent_id, p.position, p.body]}.should == [
+        [nil, 1, "Originally 1"],
+        [nil, 2, "New"],
+        [nil, 3, "Originally 2"],
+        [nil, 4, "Originally 3"]
+      ]
+    end
+
+    context "into a list of children" do
+      before(:each) do
+        @first_top_paragraph = @document.top_level_paragraphs.first
+        3.times{|i| @document.paragraphs.create(:parent_id => @first_top_paragraph.id, :body => "Child originally #{i + 1}")}
+      end
+
+      it "inserts a paragraph at the top" do
+        paragraph = @document.paragraphs.build(:body => "New", :before_id => @first_top_paragraph.children.first.id)
+        paragraph.save!
+        @first_top_paragraph.reload
+        @first_top_paragraph.children.map{|p| [p.parent_id, p.position, p.body]}.should == [
+          [@first_top_paragraph.id, 1, "New"],
+          [@first_top_paragraph.id, 2, "Child originally 1"],
+          [@first_top_paragraph.id, 3, "Child originally 2"],
+          [@first_top_paragraph.id, 4, "Child originally 3"]
+        ]
+      end
+
+      it "inserts a paragraph at the bottom" do
+        paragraph = @document.paragraphs.build(:body => "New", :after_id => @first_top_paragraph.children.last.id)
+        paragraph.save!
+        @first_top_paragraph.reload
+        @first_top_paragraph.children.map{|p| [p.parent_id, p.position, p.body]}.should == [
+          [@first_top_paragraph.id, 1, "Child originally 1"],
+          [@first_top_paragraph.id, 2, "Child originally 2"],
+          [@first_top_paragraph.id, 3, "Child originally 3"],
+          [@first_top_paragraph.id, 4, "New"]
+        ]
+      end
+
+      it "inserts a paragraph in the middle" do
+        paragraph = @document.paragraphs.build(:body => "New", :before_id => @first_top_paragraph.children[1].id)
+        paragraph.save!
+        @first_top_paragraph.reload
+        @first_top_paragraph.children.map{|p| [p.parent_id, p.position, p.body]}.should == [
+          [@first_top_paragraph.id, 1, "Child originally 1"],
+          [@first_top_paragraph.id, 2, "New"],
+          [@first_top_paragraph.id, 3, "Child originally 2"],
+          [@first_top_paragraph.id, 4, "Child originally 3"]
+        ]
+      end
+    end
+  end
+
+  describe "deleting" do
+    it "deletes its children" do
+      @document = Rticles::Document.create
+      @tlp = @document.top_level_paragraphs.create(:body => "top-level")
+      3.times{@document.paragraphs.create(:parent_id => @tlp.id)}
+      @document.paragraphs.map{|p| [p.parent_id, p.position]}.should eq [
+        [nil, 1],
+        [@tlp.id, 1],
+        [@tlp.id, 2],
+        [@tlp.id, 3]
+      ]
+
+      @document.paragraphs.count.should eq 4
+      @document.reload.top_level_paragraphs.first.destroy
+      @document.reload.paragraphs.count.should == 0
+    end
+  end
+
+  describe "indenting" do
+    it "makes the paragraph a child of its previous sibling" do
+      stub_outline([:one, :two])
+      @document.top_level_paragraphs[1].indent!
+      @document.reload.outline.should == ['one', ['two']]
+    end
+
+    it "goes at the bottom of the previous sibling's children" do
+      stub_outline([:one, [:sub_one, :sub_two], :two])
+      @document.top_level_paragraphs[1].indent!
+      @document.reload.outline.should == ['one', ['sub_one', 'sub_two', 'two']]
+    end
+  end
+
+  describe "outdenting" do
+    it "inserts itself back into its parent's level" do
+      stub_outline([:one, [:two]])
+      @document.top_level_paragraphs[0].children[0].outdent!
+      @document.reload.outline.should == ['one', 'two']
+    end
+
+    it "splits its siblings" do
+      stub_outline [:one, [:sub_one, :sub_two, :sub_three], :two]
+      @document.top_level_paragraphs[0].children[1].outdent!
+      @document.reload.outline.should == ['one', ['sub_one'], 'sub_two', ['sub_three'], 'two']
+    end
+  end
+
+  describe "index" do
+    before(:each) do
+      @document = Rticles::Document.create
+      @document.top_level_paragraphs.create(:body => 'one')
+      @document.top_level_paragraphs.create(:body => 'Heading one', :heading => 1)
+      @document.top_level_paragraphs.create(:body => 'two')
+      @document.top_level_paragraphs.create(:body => '#rticles#false#choice Optional paragraph')
+      @document.top_level_paragraphs.create(:body => 'three')
+
+      @document.choices[:choice] = true
+    end
+
+    it "ignores headings" do
+      @document.paragraphs[0].index.should eq 1
+      @document.paragraphs[2].index.should eq 2
+    end
+
+    it "returns nil for headings" do
+      @document.paragraphs[1].index.should be_nil
+    end
+
+    it "ignores paragraphs omitted by choices" do
+      @document.paragraphs[4].index(@document.choices).should eq 3
+    end
+  end
+
+  describe "generating HTML" do
+    before(:each) do
+      @document = Rticles::Document.create
+      @document.top_level_paragraphs.create(:body => "A Simple Constitution", :heading => 1)
+      @document.top_level_paragraphs.create(:body => "For demonstration purposes only", :heading => 2, :continuation => true)
+
+      @document.top_level_paragraphs.create(:body => "This is the first rule.")
+
+      p = @document.top_level_paragraphs.create(:body => "This is the second rule, which applies when:")
+      @document.paragraphs.create(:body => "This condition;", :parent_id => p.id)
+      @document.paragraphs.create(:body => "and this condition.", :parent_id => p.id)
+      @document.top_level_paragraphs.create(:body => "except when it is a Full Moon.", :continuation => true)
+
+      @document.top_level_paragraphs.create(:body => "This is the third rule.")
+
+      @document.top_level_paragraphs.create(:body => "This is the fourth rule.")
+      @document.top_level_paragraphs.create(:body => "And finally...", :heading => 2)
+      @document.top_level_paragraphs.create(:body => "This is the final rule.")
+    end
+
+    it "works" do
+      expected_html = <<-EOF
+      <section>
+        <hgroup>
+          <h1>A Simple Constitution</h1>
+          <h2>For demonstration purposes only</h2>
+        </hgroup>
+        <ol>
+          <li>1 This is the first rule.</li>
+          <li>
+            2 This is the second rule, which applies when:
+            <ol>
+              <li>2.1 This condition;</li>
+              <li>2.2 and this condition.</li>
+            </ol>
+            except when it is a Full Moon.
+          </li>
+          <li>3 This is the third rule.</li>
+          <li>4 This is the fourth rule.</li>
+        </ol>
+        <h2>And finally...</h2>
+        <ol>
+          <li>5 This is the final rule.</li>
+        </ol>
+      </section>
+      EOF
+
+      html = @document.to_html
+
+      html.should be_equivalent_to(expected_html)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../dummy/config/environment", __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

data/spec/support/custom_matchers.rb

@@ -0,0 +1 @@
+require 'equivalent-xml/rspec_matchers'

data/spec/support/document_macros.rb

@@ -0,0 +1,30 @@
+module DocumentMacros
+  def stub_outline(outline=[])
+    @document ||= Rticles::Document.create
+    i = 0
+    while i < outline.length
+      tlp = @document.top_level_paragraphs.create(:body => outline[i].to_s)
+      if outline[i + 1].is_a?(Array)
+        stub_child_paragraphs(tlp, outline[i + 1])
+        i += 2
+      else
+        i += 1
+      end
+    end
+    @document
+  end
+
+  def stub_child_paragraphs(p, outline)
+    document = p.document
+    i = 0
+    while i < outline.length
+      sp = document.paragraphs.create(:body => outline[i].to_s, :parent_id => p.id)
+      if outline[i + 1].is_a?(Array)
+        stub_child_paragraphs(sp, outline[i + 1])
+        i += 2
+      else
+        i += 1
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: rticles
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Mear
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: acts_as_list
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: roman-numerals
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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.
+email:
+- getinvolved@oneclickorgs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/TODO.txt
+- lib/rticles.rb
+- lib/rticles/document.rb
+- lib/rticles/generators/install_generator.rb
+- lib/rticles/generators/templates/create_documents_and_paragraphs.rb
+- lib/rticles/numbering.rb
+- lib/rticles/paragraph.rb
+- lib/rticles/railtie.rb
+- lib/rticles/version.rb
+- lib/tasks/rticles_tasks.rake
+- rticles.gemspec
+- spec/document_spec.rb
+- spec/dummy/.gitignore
+- spec/dummy/.rspec
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/javascripts/documents.js
+- spec/dummy/app/assets/stylesheets/application.css.sass
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/documents_controller.rb
+- spec/dummy/app/controllers/paragraphs_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/helpers/documents_helper.rb
+- spec/dummy/app/helpers/paragraphs_helper.rb
+- spec/dummy/app/mailers/.gitkeep
+- spec/dummy/app/models/.gitkeep
+- spec/dummy/app/views/documents/edit.html.haml
+- spec/dummy/app/views/documents/index.html.haml
+- spec/dummy/app/views/documents/new.html.haml
+- spec/dummy/app/views/documents/show.html.haml
+- spec/dummy/app/views/layouts/application.html.haml
+- spec/dummy/app/views/paragraphs/_form.html.haml
+- spec/dummy/app/views/paragraphs/_paragraph.html.haml
+- spec/dummy/app/views/paragraphs/_paragraph_internal.html.haml
+- spec/dummy/app/views/paragraphs/edit.html.haml
+- spec/dummy/app/views/paragraphs/new.html.haml
+- spec/dummy/app/views/paragraphs/update.js.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/migrate/20120828203449_create_documents_and_paragraphs.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/lib/assets/.gitkeep
+- spec/dummy/log/.gitkeep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/fixtures/constitution.yml
+- spec/fixtures/ips.yml
+- spec/fixtures/simple.yml
+- spec/paragraph_spec.rb
+- spec/spec_helper.rb
+- spec/support/custom_matchers.rb
+- spec/support/document_macros.rb
+homepage: https://github.com/oneclickorgs/rticles
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Consistent editing for legal documents.
+test_files: []