lbp 0.0.1

data/spec/config_globals.rb

@@ -0,0 +1,18 @@
+$confighash = { texts_dir: "/Users/JCWitt/WebPages/lbplib-testfiles/pp-projecfiles/GitTextfiles/", 
+		projectdatafile_dir: "/Users/JCWitt/WebPages/lbplib-testfiles/pp-projectfiles/Conf/", 
+		xslt_critical_dir: "/Users/JCWitt/WebPages/lbpwrapper/lombardpress/public/pl_xslt_stylesheets/",
+		xslt_documentary_dir: "/Users/JCWitt/WebPages/lbpwrapper/lombardpress/public/pl_xslt_stylesheets/", 
+		xslt_main_view: "text_display.xsl",
+		xslt_index_view: "text_display_index.xsl", 
+		xslt_clean: "clean_forStatistics.xsl",
+		xslt_plain_text: "plaintext.xsl", 
+		xslt_toc: "lectio_outline.xsl", 
+		git_repo: "bitbucket.org/jeffreycwitt/"}
+
+
+#filehash = {path: "https://bitbucket.org/jeffreycwitt/lectio1/raw/master/lectio1.xml", fs: "lectio1", ed: "master", type: "critical", source: "origin"}
+$filehash = {path: "/Users/JCWitt/WebPages/lbplib-testfiles/pp-projectfiles/GitTextfiles/lectio1/lectio1.xml", fs: "lectio1", ed: "master", type: "critical", source: "local"}
+
+$projectfile = "/Users/JCWitt/WebPages/lbplib-testfiles/pp-projectfiles/Conf/projectdata.xml"
+
+$pg_projectfile = "/Users/JCWitt/WebPages/lbplib-testfiles/pg-projectfiles/Conf/projectdata.xml"

data/spec/item_group_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'lbp'
+require 'pry'
+require 'nokogiri'
+
+describe 'item group object' do 
+	
+	require_relative "config_globals"
+	
+	$itemgroup = Lbp::ItemGroup.new($projectfile, "deFide")
+
+	it 'should return the item group id input at initialization' do 
+		result = $itemgroup.igid
+		expect(result).to be_kind_of(String)
+	end
+
+	it 'should return an array of Item objects from with the Item group' do 
+		result = $itemgroup.items
+		expect(result).to be_kind_of(Array)
+	end
+	it 'should return an specific item object when a specific item group id is given' do
+		result = $itemgroup.item('lectio1')
+		expect(result).to be_kind_of(Lbp::Item)
+	end
+	it 'should return the title of the item group' do 
+		result = $itemgroup.title
+		expect(result).to be_kind_of(String)
+	end
+	it 'should return return true if the group has sub-groups and false if it does not' do 
+		result = $itemgroup.has_sub_group?
+		# not ideal because I would prefer the test to pass if the result is either false or true
+		expect(result).to be false
+	end
+	it 'should return return true if the group has sub-groups and false if it does not' do 
+		result = $itemgroup.has_parent_group?
+		# not ideal because I would prefer the test to pass if the result is either false or true
+		expect(result).to be false
+	end
+end

data/spec/item_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'lbp'
+require 'pry'
+require 'nokogiri'
+
+describe 'item object' do 
+	
+	require_relative "config_globals"
+
+	$itemobject = Lbp::Item.new($projectfile, 'lectio1')
+
+	it 'should return the filestem given at construction' do
+		result = $itemobject.fs 
+		expect(result).to be_kind_of(String)
+	end
+
+	it 'should return the full directory path of file' do 
+		result = $itemobject.file_dir 
+		expect(result).to be_kind_of(String)
+	end
+
+	it 'should retrieve the item name from the TEI xml file' do 
+		result = $itemobject.title
+		expect(result).to be_kind_of(String)
+	end
+	it 'should return true when file is part of a git directory' do
+		result = $itemobject.is_git_dir
+		result.should == true 
+	end
+	it 'should return an array of branches' do
+		result = $itemobject.git_branches
+		expect(result).to be_instance_of(Array) 
+		expect(result).to include("master")
+	end
+	it 'should return an array of tags' do
+		result = $itemobject.git_tags
+		expect(result).to be_instance_of(Array) 
+		expect(result).to include("2011.10")
+	end
+	it 'should return the current branch' do
+		result = $itemobject.git_current_branch
+		expect(result).to be_instance_of(String) 
+		#expect(result).to eq("master")
+	end
+	it 'should return the sequence number of the item' do 
+		result = $itemobject.order_number
+		expect(result).to be_kind_of(Integer)
+	end
+	it 'should return an item of object of the previous item' do 
+		result = $itemobject.previous
+		expect(result).to be_instance_of(Lbp::Item)
+	end
+	it 'should return an item of object of the next item' do 
+		result = $itemobject.next
+		expect(result).to be_instance_of(Lbp::Item)
+	end
+	it 'should return a transcription object' do 
+		result = $itemobject.transcription
+		expect(result).to be_instance_of(Lbp::Transcription)
+	end
+	it 'should return a file path for a specified transcription' do 
+		result = $itemobject.file_path
+		expect(result).to be_kind_of(String)
+	end
+	it 'should return a filehash' do 
+		result = $itemobject.file_hash
+		expect(result).to be_kind_of(Hash)
+	end
+	it 'should return an array of Transcriptions objects when transcriptions method is called' do 
+		result = $itemobject.transcriptions
+		expect(result).to be_kind_of(Array)
+	end
+	
+end

data/spec/paragraph_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'lbp'
+require 'pry'
+require 'nokogiri'
+
+describe 'paragraph object' do
+		
+		require_relative "config_globals"
+		paragraph1 = "l1-cpspfs"
+		paragraph3 = "l1-shoatd"
+		$paragraph = Lbp::Paragraph.new($projectfile, $filehash, paragraph1)
+
+	it 'should return the pid for the Paragraph object' do 
+		result = $paragraph.pid
+		
+		expect(result).to be_kind_of(String)
+	end
+	it 'should return the number of the paragraph number' do 
+		result = $paragraph.number
+		expect(result).to be_kind_of(Integer)
+	end
+	it 'should return the next paragraph object or nil if there are no more paragraphs' do
+		result = $paragraph.next
+		expect(result).to be_kind_of(Lbp::Paragraph)
+	end
+	it 'should return the previous paragraph object or nil if there are no more paragraphs' do
+		result = $paragraph.previous
+		#this test works but I don't know how to write a test matching object or nil
+		#expect(result).to be(Lbp::Paragraph || nil) 
+	end
+	it 'should return the plain text of the paragraph as a nokogiri object' do 
+		
+		result = $paragraph.transform_plain_text
+		expect(result).to be_instance_of(Nokogiri::XML::NodeSet)
+	end
+	
+end 

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/transcription_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+require 'lbp'
+require 'pry'
+require 'nokogiri'
+
+describe 'transcription object' do 
+	
+	require_relative "config_globals"
+	$transcriptionobject = Lbp::Transcription.new($projectfile, $filehash)
+
+	it 'should return the filestem given at construction' do
+		result = $transcriptionobject.fs 
+		expect(result).to be_kind_of(String)
+	end
+
+	it 'should return the full filename for an edited item' do
+		result = $transcriptionobject.file_path
+		expect(result).to be_kind_of(String)
+	end
+	it 'should retrieve the item name from the TEI xml file' do 
+		result = $transcriptionobject.title
+		expect(result).to be_kind_of(String)
+	end
+
+	it 'should retrieve the author name from the TEI xml file' do 
+		result = $transcriptionobject.author
+		expect(result).to be_kind_of(String) 
+	end
+	it 'should retrieve the editor name from the TEI xml file' do 
+		result = $transcriptionobject.editor
+		expect(result).to be_kind_of(String) 
+	end
+	it 'should retrieve the edition number from TEI xml file' do 
+		result = $transcriptionobject.ed_no
+		expect(result).to be_kind_of(String) 
+	end
+	it 'should retrieve the edition date from TEI xml file' do 
+		result = $transcriptionobject.ed_date
+		expect(result).to be_kind_of(String) 
+	end
+	it 'should retrieve the pubdate from TEI xml file' do 
+		result = $transcriptionobject.pub_date
+		expect(result).to be_kind_of(String)
+	end
+	it 'should retrieve the encoding method from TEI xml file' do 
+		result = $transcriptionobject.encoding_method
+		expect(result).to be_kind_of(String) 
+	end
+	it 'should retrieve the encoding location from TEI xml file' do 
+		result = $transcriptionobject.encoding_location
+		expect(result).to be_kind_of(String) 
+	end
+=begin	
+	it 'should retrieve the number of columns based on presence of cb element and return 2' do 
+		result = $transcriptionobject.number_of_columns('svict')
+		result.should == nil
+	end
+=end
+=begin
+	it 'should retrieve the number of columns based on presence of pb element and return 1' do 
+		result = $itemobject.number_of_columns('erlang')
+		result.should == 1 
+	end
+=end
+
+	it 'should transform a doc using a specified xslt file' do
+		xslt_param_array = []
+		result = $transcriptionobject.transform($confighash[:xslt_critical_dir] + $confighash[:xslt_clean], xslt_param_array)
+		
+		expect(result).to be_instance_of(Nokogiri::XML::Document)
+	end
+	# This test should work, but include file paths break in XSL document
+	#it 'should process an xml doc with the text_display.xslt stylesheet' do 
+	#	result = $itemobject.transform._main_view
+	#	expect(result).to be_instance_of(Nokogiri::XML::Document)
+	#end
+	#it 'should process an xml doc with the text_display.xsl stylesheet' do 
+	#	result = $itemobject.transform_index_view
+	#	expect(result).to be_instance_of(Nokogiri::XML::Document)
+	#end
+	it 'should process an xml doc with the cleanForStatistics.xsl stylesheet' do 
+		file_path = $transcriptionobject.file_path
+		nokogiri = $transcriptionobject.nokogiri
+		result = $transcriptionobject.transform_clean
+		
+		expect(result).to be_instance_of(Nokogiri::XML::Document)
+	end
+	it 'should process an xml doc with the text_display.xsl stylesheet' do 
+		result = $transcriptionobject.transform_toc
+		expect(result).to be_instance_of(Nokogiri::XML::Document)
+	end
+	it 'should process an xml doc with the text_display.xsl stylesheet' do 
+		result = $transcriptionobject.transform_plain_text
+		expect(result).to be_instance_of(Nokogiri::XML::Document)
+	end
+	it 'should get the word count of the item object' do 
+		result = $transcriptionobject.word_count
+		#result.should eq(2122)
+		expect(result).to be_kind_of(Integer)
+	end
+	it 'should get the word frequency of the item object' do 
+		result = $transcriptionobject.word_frequency("word", "ascending")
+
+		expect(result).to be_kind_of(Hash)
+	end
+	it 'should get the paragraph count of the item object' do 
+		result = $transcriptionobject.number_of_body_paragraphs
+		
+		expect(result).to be_kind_of(Integer)
+	end
+	it 'should return an array of paragraph objects' do
+		result = $transcriptionobject.paragraphs
+		
+		expect(result).to be_kind_of(Array)
+	end
+	it 'should return an paragraph object for the named id' do
+		result = $transcriptionobject.paragraph("l1-cpspfs")
+		expect(result).to be_instance_of(Lbp::Paragraph)
+	end
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: lbp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeffrey C. Witt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdf-rdfxml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library for working XML documents conforming the TEI (lbp customized)
+  schema
+email:
+- jeffreycwitt@gmail.com
+executables:
+- lbp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/lbp
+- lbp.gemspec
+- lib/lbp.rb
+- lib/lbp/collection.rb
+- lib/lbp/functions.rb
+- lib/lbp/item.rb
+- lib/lbp/item_group.rb
+- lib/lbp/paragraph.rb
+- lib/lbp/transcription.rb
+- lib/lbp/version.rb
+- spec/collection_spec.rb
+- spec/config_globals.rb
+- spec/item_group_spec.rb
+- spec/item_spec.rb
+- spec/paragraph_spec.rb
+- spec/spec_helper.rb
+- spec/transcription_spec.rb
+homepage: ''
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A library for working XML documents conforming the TEI (lbp customized) schema
+test_files:
+- spec/collection_spec.rb
+- spec/config_globals.rb
+- spec/item_group_spec.rb
+- spec/item_spec.rb
+- spec/paragraph_spec.rb
+- spec/spec_helper.rb
+- spec/transcription_spec.rb