lbp 0.0.2 → 0.1.0

data/lib/lbp/collection.rb

@@ -1,131 +0,0 @@
-require 'nokogiri'
-require 'rugged'
-require 'lbp/functions'
-
-
-module Lbp
-	class Collection
-		#attr_reader :confighash
-		def initialize(projectfile)
-			#@confighash = self.confighash
-			#@projectdatafile_dir = @confighash[:projectdatafile_dir]
-			@projectfile = projectfile
-		end
-
-		def title
-			file = Nokogiri::XML(File.read(@projectfile))
-			title = file.xpath(("//header/collectionTitle")).text
-		end	
-		def local_texts_dir
-			file = Nokogiri::XML(File.read(@projectfile))
-			textdir = file.xpath(("//header/localTextsDirectory")).text
-		end
-
-		def citation_lists_dir
-			file = Nokogiri::XML(File.read(@projectfile))
-			citationlistdir = file.xpath(("//header/citationListsDirectory")).text
-		end
-		def git_repo
-			file = Nokogiri::XML(File.read(@projectfile))
-			gitrepo = file.xpath("//header/git_repo").text
-		end
-		#need test
-		def git_clone(username: nil, password: nil)
-			self.items.each do |item| 
-				item.git_clone(username: username, password: password)
-			end
-		end
-
-		def xslt_dirs
-			#test change to hash
-			@xslthash = Hash.new
-			file = Nokogiri::XML(File.read(@projectfile))
-			schemas = file.xpath("//header/xsltDirectories/schema")
-
-			schemas.each do |schema| 
-				schema_number = schema.attributes["version"].value 
-				schema_default = schema.attributes["default"].value 
-				@xslthash["#{schema_number}"] = {
-					critical: schema.children.find {|child| child.name == "critical"}.text,
-					documentary: schema.children.find {|child| child.name == "documentary"}.text,
-					main_view: schema.children.find {|child| child.name == "main_view"}.text,
-					index_view: schema.children.find {|child| child.name == "index_view"}.text,
-					clean_view: schema.children.find {|child| child.name == "clean_view"}.text,
-					plain_text: schema.children.find {|child| child.name == "plain_text"}.text,
-					toc: schema.children.find {|child| child.name == "toc"}.text
-				}
-				if schema_default == 'true'
-						@xslthash["default"] = {
-						critical: schema.children.find {|child| child.name == "critical"}.text,
-						documentary: schema.children.find {|child| child.name == "documentary"}.text,
-						main_view: schema.children.find {|child| child.name == "main_view"}.text,
-						index_view: schema.children.find {|child| child.name == "index_view"}.text,
-						clean_view: schema.children.find {|child| child.name == "clean_view"}.text,
-						plain_text: schema.children.find {|child| child.name == "plain_text"}.text,
-						toc: schema.children.find {|child| child.name == "toc"}.text
-					}
-					end
-					
-			end
-			return @xslthash
-			
-		end
-
-		def confighash
-			confighash = {
-				local_texts_dir: self.local_texts_dir, 
-				citation_lists_dir: self.citation_lists_dir, 
-				xslt_dirs: self.xslt_dirs, 
-				git_repo: self.git_repo}
-		end
-
-		def items
-			file = Nokogiri::XML(File.read(@projectfile))
-			result = file.xpath("//div[@id='body']//item/fileName/@filestem")
-			fs_array = result.map do |fs| 
-				Item.new(@projectfile, fs.value)
-			end
-			return fs_array
-		end
-		def item(fs)
-			Item.new(@projectfile, fs)
-		end
-
-		def item_filestems
-			file = Nokogiri::XML(File.read(@projectfile))
-			result = file.xpath("//div[@id='body']//item/fileName/@filestem")
-
-			fs_array = result.map do |fs| 
-				fs.value
-			end
-			return fs_array
-		end
-
-		def item_titles
-			file = Nokogiri::XML(File.read(@projectfile))
-			result = file.xpath("//div[@id='body']//item/title")
-
-			title_array = result.map do |title| 
-				title.text
-			end
-			return title_array
-		end
-
-		def items_fs_title_hash
-			file = Nokogiri::XML(File.read(@projectfile))
-			result = file.xpath("//div[@id='body']//item")
-
-			fs_title_hash = Hash.new
-
-			result.each do |item| 
-				title = item.children.find {|child| child.name == "title"}.text
-				fs = item.children.find {|child| child.name == "fileName"}.attributes["filestem"].value
-				fs_title_hash[fs] = title
-			end
-			return fs_title_hash
-
-
-		end
-
-	end
-end

data/lib/lbp/item.rb

@@ -1,153 +0,0 @@
-require 'nokogiri'
-require 'rugged'
-require 'lbp/functions'
-require 'lbp/transcription'
-
-module Lbp
-	class Item 
-		attr_reader :fs, :local_texts_dir, :file_dir, :projectfile, :xslt_dir
-		
-		def initialize(projectfile, fs)
-      @fs = fs
-      @projectfile = projectfile
-      
-      @confighash = Collection.new(projectfile).confighash
-      @texts_dir = @confighash[:local_texts_dir]
-			@file_dir = @confighash[:local_texts_dir] + @fs + "/"
-
-	  end
-	  ### Item Header Extraction and Metadata Methods
-		def title
-			transcr = Transcription.new(@projectfile, self.file_hash)
-			transcr.title
-		end
-		
-   	### Begin GIT functions ###
-  	def is_git_dir
-  		gitpath = @file_dir + ".git"
-  		
-  		if File.directory?(gitpath) 
-  			true
-  		else
-  			false
-  		end
-  	end
-  	def git_branches
-  		repo = Rugged::Repository.new(@file_dir)
-  		branches = repo.branches.map { |branch| branch.name }
-		return branches
-		end
-		def git_current_branch
-  		repo = Rugged::Repository.new(@file_dir)
-  		current_branch = repo.head.name.gsub(%r!\Arefs/heads/(.*)\z!) { $1 }
-  		return current_branch
-  	end
-  	def git_tags
-  		repo = Rugged::Repository.new(@file_dir)
-  		tags = repo.tags.map { |tag| tag.name }
-		return tags
-  	end
-  	#need test for this 
-  	def git_checkout(branch)
-  		repo = Rugged::Repository.new(@file_dir)
-  		repo.checkout(branch)
-		end
-		def git_construct_remote_path
-				remote_path = "https://#{@confighash[:git_repo]}#{@fs}.git";
-		end
-		
-		def git_username_password_credentials(username, password) 
-			Rugged::Credentials::UserPassword
-			credentials = Rugged::Credentials::UserPassword.new(:username=>username, :password=>password)
-			return credentials
-			end
-		#needs a test	
-		def git_clone(username: nil, password: nil)
-			remote_path = self.git_construct_remote_path
-			Rugged::Repository.clone_at(remote_path, @file_dir, :credentials => self.git_username_password_credentials(username, password))
-		end
-		#nneds a test
-		def git_pull(username: nil, password: nil)
-			# not sure what the Rugged API is for this.
-			# doesn't like this methods has been created 
-			# for now it may have to be constructed from fetch and merge
-			# or my method 'git_pull' could simply delete the existing repository and the re-lcone
-				#this is is what i'm doing below, but it is not ideal
-			self.remove_local_dir
-			self.git_clone(username: username, password: password)
-		end
-		#needs a test
-		def remove_local_dir
-			FileUtils.rm_rf @file_dir
-		end
-		### End Git Methods ###
-		### Begin Order Info ##
-
-		# previous and next functions don't handle ends of arrays very well	
-		# they also rely on the "item_filestems" methods which works but should be changed see comments in collection file
-		def previous
-			sequence_array = Collection.new(@projectfile).item_filestems
-			#if sequence_array[sequence_array.index(@fs) - 1 ] != nil
-				previous_fs = sequence_array[sequence_array.index(@fs) - 1]
-				previous_item = Item.new(@projectfile, previous_fs)
-			#else
-			#	previous_item = nil
-			#end
-			return previous_item
-		end
-		def next
-			sequence_array = Collection.new(@projectfile).item_filestems
-			#if sequence_array[@sequence_array.index(@fs) + 1 ] != nil
-				next_fs = sequence_array[sequence_array.index(@fs) + 1]
-				next_item = Item.new(@projectfile, next_fs)
-			#else
-			#	next_item = nil
-			#end
-			return next_item
-		end
-		def order_number
-			sequence_array = Collection.new(@projectfile).item_filestems
-			array_number = sequence_array.index(@fs)
-			sequence_number = array_number + 1
-			return sequence_number
-		end
-		
-		def file_path(source: 'local', wit: 'critical', ed: 'master')
-			if wit == 'critical'
-				if source == "origin"
-					file_path = "https://#{@confighash[:git_repo]}#{@fs}/raw/#{ed}/#{@fs}.xml"
-				else
-       		file_path = @file_dir + @fs + ".xml"
-       	end
-      else
-      	if source == "origin"
-					file_path = "http://#{@confighash[:git_repo]}#{@fs}/raw/#{ed}/#{wit}_#{@fs}.xml"
-				else
-    			file_path = @file_dir + wit + "_" + @fs + ".xml"
-    		end
-    	end
-    	return file_path
-    end
-    def file_hash(source: 'local', wit: 'critical', ed: 'master')
-    	type = if wit == "critical" then "critical" else "documentary" end
-    	filehash = {path: self.file_path(source: source, wit: wit, ed: ed), fs: @fs, ed: ed, type: type, source: source}
-			
-			return filehash
-    end
-    
-    def transcription(source: 'local', wit: 'critical', ed: 'master')
-    	filehash = self.file_hash(source: source, wit: wit, ed: ed)
-    	transcr = Transcription.new(@projectfile, filehash)
-		end	
-		def transcriptions(source: 'local', ed: 'master')
-			file = Nokogiri::XML(File.read(@projectfile))
-			parts = file.xpath("//item[fileName/@filestem='#{@fs}']/hasParts/part/slug")
-			transcription_array = parts.map do |part| 
-				self.transcription(source: source, wit: part.text, ed: ed)
-			end
-			transcription_array << self.transcription(source: source, wit: 'critical', ed: ed)
-
-			return transcription_array
-		end
-	end
-end

data/lib/lbp/item_group.rb

@@ -1,52 +0,0 @@
-require 'nokogiri'
-require 'rugged'
-require 'lbp/functions'
-require 'lbp/transcription'
-
-module Lbp
-	class ItemGroup
-		attr_reader :igid
-		
-		def initialize(projectfile, igid)
-      @igid = igid
-      @projectfile = projectfile
-      
-    end
-
-    def items
-			file = Nokogiri::XML(File.read(@projectfile))
-			result = file.xpath("//div[@id='#{@igid}']//item/fileName/@filestem")
-			fs_array = result.map do |fs| 
-				Item.new(@projectfile, fs.value)
-			end
-			return fs_array
-		end
-		def item(fs)
-			Item.new(@projectfile, fs)
-		end
-		def title
-			file = Nokogiri::XML(File.read(@projectfile))
-			result = file.xpath("//div[@id='#{@igid}']/head")
-			return result.text
-		end
-		def has_sub_group?
-			file = Nokogiri::XML(File.read(@projectfile))
-			result = file.xpath("//div[@id='#{@igid}']//div")
-			if result.count == 0
-				false
-			else
-				true
-			end
-		end
-		def has_parent_group?
-			#I sort of hate this method. But it sort of works, though I can imagine problems.
-			file = Nokogiri::XML(File.read(@projectfile))
-			result = file.xpath("//div[@id='#{@igid}'][@class='toplevel']")
-			if result.count == 0
-				true
-			else
-				false
-			end
-		end
-	end
-end

data/lib/lbp/paragraph.rb

@@ -1,87 +0,0 @@
-require 'nokogiri'
-require 'rugged'
-require 'lbp/functions'
-
-module Lbp
-	class Paragraph
-		attr_reader :pid 
-		def initialize(projectfile, filehash, pid)
-			
-			@projectfile = projectfile
-			@filehash = filehash
-			@pid = pid
-			
-			@confighash = Collection.new(@projectfile)
-	  end
-
-	  def number
-	  	transcr = Transcription.new(@projectfile, @filehash)
-	  	totalparagraphs = transcr.number_of_body_paragraphs
-	  	xmlobject = transcr.nokogiri
-	  	paragraphs_following = xmlobject.xpath("//tei:body//tei:p[preceding::tei:p[@xml:id='#{@pid}']]", 'tei' => 'http://www.tei-c.org/ns/1.0').count
-	  	paragraph_number = totalparagraphs - paragraphs_following
-	  	
-			return paragraph_number
-	  end
-	  def next
-	  	xmlobject = Transcription.new(@projectfile, @filehash).nokogiri
-	  	nextpid = xmlobject.xpath("//tei:p[@xml:id='#{@pid}']/following::tei:p[1]/@xml:id", 'tei' => 'http://www.tei-c.org/ns/1.0')
-			if nextpid.text == nil
-        return nil
-      else
-				return Paragraph.new(@projectfile, @filehash, nextpid.text)
-      end
-	  end
-	  def previous
-	  	xmlobject = Transcription.new(@projectfile, @filehash).nokogiri
-	  	previouspid = xmlobject.xpath("//tei:p[@xml:id='#{@pid}']/preceding::tei:p[1]/@xml:id", 'tei' => 'http://www.tei-c.org/ns/1.0')
-	  	if previouspid.empty?
-        return nil
-      else
-				return Paragraph.new(@projectfile, @filehash, previouspid.text)
-      end
-	  end
-	  def transform(xsltfile, xslt_param_array=[])
-	  	result = Transcription.new(@projectfile, @filehash).transform(xsltfile, xslt_param_array)
-			p = result.xpath("//p[@id='#{@pid}']")
-			return p
-		end
-		def transform_plain_text(xslt_param_array=[])
-			# not that it could be slightly confusing that paragraph plain text uses the transform clean,
-			# because we still the basic paragraph elements in order to select the desired paragraph
-			result = Transcription.new(@projectfile, @filehash).transform_clean(xslt_param_array)
-			
-			p = result.xpath("//p[@id='#{@pid}']")
-			return p
-		end
-		def word_count
-    	plaintext = self.transform_plain_text
-    	size = plaintext.text.split.size
-    end
-    def word_array
-    	plaintext = self.transform_plain_text
-    	word_array = plaintext.text.split
-    	word_array.map!{ |word| word.downcase}
-    end
-    def word_frequency(sort='frequency', order='descending')
-    	word_array = self.word_array
-    	wf = Hash.new(0)
-			word_array.each { |word| wf[word] += 1 }
-			
-			if sort == "frequency" 
-				if order == "descending" # high to low
-					wf = wf.sort_by{|k,v| v}.reverse
-				elsif order == "ascending" # low to high
-					wf = wf.sort_by{|k,v| v}
-				end
-			elsif sort == "word"
-				if order == "descending" # z - a
-						wf = wf.sort_by{|k,v| k}.reverse
-				elsif order == "ascending" #a - z
-						wf = wf.sort_by{|k,v| k}
-				end
-			end
-			return wf.to_h
-		end
-	end
-end

data/spec/collection_spec.rb

@@ -1,60 +0,0 @@
-require 'spec_helper'
-require 'lbp'
-require 'pry'
-require 'nokogiri'
-
-describe 'collection object' do 
-	require_relative "config_globals"
-	
-	$collection_obj = Lbp::Collection.new($pg_projectfile)
-
-	it 'should get list of item filestems in sequenced array' do 
-		result = $collection_obj.item_filestems
-		expect(result).to be_kind_of(Array)
- 	end
- 	it 'should get a list of item names in sequenced array' do 
- 		result = $collection_obj.item_titles
- 		expect(result).to be_kind_of(Array)
- 	end
- 	it 'should return a hash of filestems and item names' do 
-		result = $collection_obj.items_fs_title_hash
-		expect(result).to be_kind_of(Hash)
-	end
-
-
-
-	it 'should get list of item objects in an array' do
- 		result = $collection_obj.items
- 		#reunning result.first.title returns ERROR!!!
- 		expect(result).to be_kind_of(Array)
-	end
-
-	it 'should return local texts dir' do 
-		result = $collection_obj.local_texts_dir
-		expect(result).to be_kind_of(String)
-	end
-
-	it 'should return general repo directory' do 
-		result = $collection_obj.git_repo
-		
-		expect(result).to be_kind_of(String)
-	end
-	it 'should return citation lists directory' do 
-		result = $collection_obj.citation_lists_dir
-		expect(result).to be_kind_of(String)
-	end
-	it 'should return xslt hash' do 
-		result = $collection_obj.xslt_dirs
-		expect(result).to be_kind_of(Hash)
-	end
-	it 'should return a specific item object when a specific item group id is given' do
-		result = $collection_obj.item('lectio1')
-		expect(result).to be_kind_of(Lbp::Item)
-	end
-	it 'should return the title of a given collection specified in the project data file' do 
-		result = $collection_obj.title
-		expect(result).to be_kind_of(String)
-	end
-	
-	
-end