hard_citer 0.0.3

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Cordell
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Hard Citer 
+Hard Citer is a solution for outputting HTML bibliographies. When used in conjuction with a "cite while you write" tool, it can make writing and editing well-cited html eaiser. Using a in-text cited HTML document and a bibtex library, it can output a properly formatted bibliography. The default configuration is geared towards usage with Papers' [magic citations][1]. Papers does not provide an easy way to perform magic citations and produce a nicely formatted bibliography for HTML, from an HTML document source.
+
+For the best bang for your buck, use one of the text editors listed [here][2] 
+under the heading "Insertation of citekey" so that you can easily cite while you
+write. As an added benefit, papers will automatically group your citations in the 
+manuscript section. Export this group to a bibtex library and you are ready to 
+use Hard Citer.
+
+[1]: http://support.mekentosj.com/kb/tutorials/magic-citations 
+[2]: http://support.mekentosj.com/kb/read-write-cite/applications-supported-by-magic-citations 
+
+##Usage
+
+Require the module where you plan on using HardCiter. Initialize a new Citer object by pointing it at the bib file you exported from Papers:
+
+```Ruby
+require File.expand_path("../lib/hard_citer", __FILE__)
+citer = HardCiter::Citer.new('./examples/example_bib.bib')
+```
+
+Open the HTML file that contains the intext citations that match the bib file.
+
+```Ruby
+input_html = File.open('./examples/example_input.html','r')
+```
+
+Now, simply provide the input_html to the cite_text function and it will return the well-cited output text.
+
+```Ruby
+html_output = citer.cite_text()
+```
+
+
+You can change the output format of the citations by changing the CSL of the citer object before calling cite_text. Simply provide the path to the csl file that you would like to use.
+
+```Ruby
+citer.csl = File.expand_path("../examples/plos.csl")
+```
+
+

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+:default => :spec

data/lib/hard_citer.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require 'bibtex'
+require 'citeproc'
+require File.expand_path("../hardciter/bibliography.rb", __FILE__)
+require File.expand_path("../hardciter/cite_match.rb", __FILE__)
+require File.expand_path("../hardciter/citer.rb", __FILE__)
+require File.expand_path("../hardciter/configuration.rb", __FILE__)
+require File.expand_path("../hardciter/document.rb", __FILE__)
+require File.expand_path("../hardciter/exceptions.rb", __FILE__)
+require File.expand_path("../hardciter/library.rb", __FILE__)
+require File.expand_path("../hardciter/styler.rb", __FILE__)
+
+
+
+
+

data/lib/hardciter/bibliography.rb

@@ -0,0 +1,85 @@
+module HardCiter
+  class Bibliography
+    attr_accessor :bibliography_intext, :intext_regex, :bib_out_location, :citation_locations, :citations
+
+    def initialize
+      @bibliography_intext = HardCiter::Configuration::BIBLIOGRAPHY_INTEXT_KEY
+      @intext_regex = HardCiter::Configuration::INTEXT_REGEX
+      @citation_locations = {}
+      @citations = {}
+    end
+
+    def find_intext_citations(line)
+      line.enum_for(:scan, @intext_regex).map do
+        match = Regexp.last_match
+        pos = match.begin(0)
+        [match.to_s, pos]
+      end
+    end
+
+    def has_bibliography_key?(line)
+      line =~ @bibliography_intext
+    end
+
+    def mark_match_positions(citation_matches,line,index)
+      if citation_matches.length >  1
+        @citation_locations[index] = group_matches(citation_matches, line)
+      else
+        @citation_locations[index] = citation_matches
+      end
+    end
+
+    def parse_line(line,index)
+      @bib_out_location = index if has_bibliography_key?(line)
+      regex_matches = find_intext_citations(line) 
+    end
+
+    def group_matches(matches,line)
+      matches_grouped = []
+      current_match = matches.shift
+      until matches.empty?
+        next_match = matches.shift
+        if matches_are_paired?(current_match,next_match,line)
+          current_match = pair_two_matches(current_match, next_match)
+        else
+          matches_grouped.push(current_match) if current_match
+          current_match = next_match
+        end
+      end
+      matches_grouped.push(current_match) unless current_match.empty?
+      return matches_grouped
+    end
+
+    def pair_two_matches(current_match,next_match)
+      if current_match[0].instance_of?(Array)
+        paired_matches = current_match + next_match
+      else
+        paired_matches = [current_match,next_match]
+      end
+    end
+
+    def matches_are_paired?(match_first, match_second, line)
+      match_text, match_pos = get_match_text_and_pos(match_first)
+      next_match_pos = match_second[1]
+      end_of_match = match_pos + match_text.key.length
+      while end_of_match < next_match_pos
+        if line[end_of_match] =~ /\s/
+          end_of_match += 1
+        else
+          false
+        end
+      end
+      true
+    end
+
+    def get_match_text_and_pos(match_group)
+      if match_group[0].instance_of?(Array)
+        #match_group has sub arrays so it needs to be unpacked
+        last_match = match_group[match_group.size-1]
+      else
+        last_match = match_group
+      end
+      [last_match[0],last_match[1]]
+    end
+  end
+end

data/lib/hardciter/cite_match.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module HardCiter  
+  class CiteMatch
+    attr_accessor :bib_number, :citation, :in_cite_text, :key
+
+    def initialize(key, citation = nil, in_cite_text = nil)
+      @key = key
+      @citation = citation
+      @in_cite_text = in_cite_text
+    end
+
+  end
+end
+

data/lib/hardciter/citer.rb

@@ -0,0 +1,94 @@
+module HardCiter
+  class Citer
+    BIBTEX_LIBRARY_REGEX = /\.bib$/
+    attr_accessor :library, :styler, :csl, :bibliography
+
+    #Citer
+    def initialize(path = nil)
+      initialize_library_by_path(path) if path
+      @bibliography = HardCiter::Bibliography.new
+      @styler = HardCiter::Styler.new
+      @csl = HardCiter::Configuration::CSL
+    end
+
+    #Citer
+    def initialize_library_by_path(path)
+      if path =~ BIBTEX_LIBRARY_REGEX
+        @library = BibTexLibrary.new(path)
+      else
+        raise "Unknown path type"
+      end
+    end
+
+    #Citer
+    def cite_text(text)
+      #validate_prerequisites 
+      doc = Document.new(text)
+      find_all_citations(doc.text_array) #move this from bib to doc? TODO
+      output_text = integrate_citations_into_text(doc.text_array)
+      output_text = integrate_bibliography_into_text(output_text)
+    end
+
+    def validate_prerequisites
+      #TODO
+      #check to make sure we have everything we need
+    end
+
+    #Citer
+    #refactor to use Document
+    def find_all_citations(text)
+      text.each_with_index() do |line, index|
+        regex_matches = @bibliography.parse_line(line,index)
+        matches = regex_matches_to_cite_matches(regex_matches) unless regex_matches.empty?
+        @bibliography.mark_match_positions(matches,line,index) unless matches.nil?        
+      end
+    end
+
+    def regex_matches_to_cite_matches(regex_matches)
+      regex_matches.map { |m| get_or_create_cite_match(m) }
+    end
+
+    # Document, Bib
+    def integrate_citations_into_text(text)
+      output_text = text.dup
+      @bibliography.citation_locations.each do |line_number,cite_matches|
+        text_line = output_text[line_number]
+        output_text[line_number] = @styler.style_line(text_line,cite_matches)
+      end
+      output_text
+    end
+
+    #
+    def integrate_bibliography_into_text(text)
+      out_location = @bibliography.bib_out_location
+      if out_location
+        bib_text = styler.get_bibliography_lines(@bibliography, @csl)
+        bib_end = out_location + 1
+        after_bib_location = text[(bib_end..text.size-1)]
+        return text[0..bib_end] + bib_text + after_bib_location
+      else
+        warn('No bib key found. \
+             Bibliography not added to cited text.')
+        return text
+      end
+    end
+
+    def get_or_create_cite_match(regex_match)
+      match_key, match_pos = regex_match
+
+      if @bibliography.citations.has_key?(match_key)
+        cite_match = @bibliography.citations[match_key]
+      else
+        cite_match = CiteMatch.new(match_key)
+        cite_match.bib_number = @bibliography.citations.length + 1
+        cite_match.citation = @library.get_citation(convert_match_to_cite_key(match_key))
+        @bibliography.citations[match_key] = cite_match
+      end
+      [cite_match, match_pos]
+    end
+
+    def convert_match_to_cite_key(match)
+      match.gsub(/\{|\}/, '')
+    end
+  end
+end

data/lib/hardciter/configuration.rb

@@ -0,0 +1,34 @@
+module HardCiter
+  class Configuration
+    attr_accessor :csl, :bibliography_intext, :intext_regex
+
+    CSL = File.expand_path("../../../examples/plos.csl", __FILE__)
+      
+    BIBLIOGRAPHY_INTEXT_KEY = /\{papers2_bibliography\}/
+
+    INTEXT_REGEX = /\{(\w*:\w*)\}/
+
+    def initialize
+      self.reset
+    end
+
+    def reset
+      @csl = CSL
+      @bibliography_intext = BIBLIOGRAPHY_INTEXT_KEY
+      @intext_regex = INTEXT_REGEX
+    end
+
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  def self.configure
+    yield configuration if block_given? 
+  end
+end

data/lib/hardciter/document.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'stringio'
+require File.expand_path('../exceptions', __FILE__)
+
+module HardCiter
+  class Document
+    attr_reader :text_array
+
+    def initialize(text = nil)
+      self.text_array = text
+    end
+
+    def text_array=(text)
+      if text.is_a? File
+        @text_array = text.readlines()
+      elsif text.is_a? String
+        @text_array = StringIO.open(text).readlines()
+      elsif text.is_a? Array
+        @text_array = text
+      elsif text.nil?
+        @text_array = nil
+      else
+        raise HardCiter::InvalidTextFormat
+      end
+    end
+
+  end
+end
+
+
+

data/lib/hardciter/exceptions.rb

@@ -0,0 +1,3 @@
+module HardCiter
+  class InvalidTextFormat < StandardError; end 
+end

data/lib/hardciter/library.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+require 'bibtex'
+module HardCiter
+  class Library < Hash
+
+    def initialize(path = nil)
+      load_lib(path)     
+    end
+
+
+    def load_lib(path = nil)
+      if File.exists? path
+        load_from_file(path)     
+      end
+    end
+
+    def get_citation()
+    end
+  end
+
+
+  class BibTexLibrary
+    attr_accessor :bibtex
+
+    def initialize(path)
+      load_from_file(path)
+    end
+
+    def load_from_file(path)
+      @bibtex = BibTeX.open(path)
+    end
+
+    def get_citation(key)
+      @bibtex[key]
+    end
+
+    def method_missing(method, *args, &block)
+      @bibtex.send method, *args, &block
+    end
+  end
+end

data/lib/hardciter/styler.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+require 'citeproc'
+module HardCiter
+  class Styler
+    
+    def initialize
+      @open_tag = ''
+      @close_tag = ''
+      @multi_separator = '<sup>, </sup>'
+      @separator_after_last = false
+    end
+
+    def get_bibliography_lines(bibliography_array, csl_style)
+      out_lines = ['<ol class="bibliography">']
+      bibliography_array.citations.each do |cite_key, cite_match|
+        entry = cite_match.citation
+        if entry.nil?
+          cite_text = cite_key
+        else
+          cite_text = CiteProc.process(cite_match.citation.to_citeproc,
+                                       style: csl_style, format: :html)
+          strip_extra_papers_brackets cite_text
+        end
+
+        out_lines.push '<li><a name = "' +
+                       "bibliography_#{cite_match.bib_number}\">" +
+                       cite_text + '</a></li>'
+      end
+      out_lines.push '</ol>'
+    end
+
+    def strip_extra_papers_brackets(line)
+        line.gsub!(/\{|\}/, '')
+    end
+
+    def style_line(line, citations)
+      processed_line = ''
+      pos_off_set = 0
+      citations.each do |cite_match|
+        if cite_match[0].is_a?(CiteMatch)
+          output, offset = single_cite(cite_match[0],
+                                       cite_match[1] - pos_off_set, line)
+          pos_off_set += offset
+
+        elsif cite_match[0].is_a? Array
+          output = multi_cite(cite_match, line, pos_off_set)
+        end
+        if output.nil?
+          puts "wait"
+        end
+        processed_line += output
+      end
+      processed_line += line
+    end
+
+    def multi_cite(cite_match_array, line, pos_offset)
+      output_line = @open_tag
+      cite_match_array.each_with_index do |cite_match, index|
+        citation, pos = cite_match
+        output, off_set = single_cite(citation, pos - pos_offset, line)
+        output_line += output
+        output_line += @multi_separator unless index == cite_match.size - 1
+        pos_offset += off_set
+      end
+      output_line += @close_tag
+
+    end
+
+    def single_cite(citation, pos, line)
+      key = citation.key
+      pos == 0 ? before_cite = '' : before_cite = line.slice!(0..pos - 1)
+      cite = line.slice!(0..key.length - 1)
+      off_set = before_cite.length + cite.length
+      in_text_citation = "<sup><a href = \"#bibliography_#{citation.bib_number}\
+                          \">#{citation.bib_number}</a></sup>"
+      output_line = before_cite + in_text_citation
+      [output_line, off_set]
+    end
+
+  end
+end

data/lib/scrap_methods

@@ -0,0 +1,44 @@
+  def find_blocks(lines)
+    r=Regexp.compile('\{.*\}')
+    line_count=0
+    lines.each do 
+      |line|
+      matches=r.match(all_lines)
+      matches.each { |match| puts "Line # #{line_count}: #{match}" }
+      line_count += 1
+    end
+  end
+
+  def find_blocks_manually(lines)
+    line_count=0
+    pairs=[]
+    open_blocks = []
+    lines.each do
+        |line|
+        char_line_count=0
+        line.each_char do
+          |c|
+          if c.eql?("{")
+            open_blocks.push([line_count,char_line_count])
+          elsif c.eql?("}") && open_blocks.empty?
+            puts "Un-openend close found at Line Num = #{line_count}, "+
+                                            "Char_num= #{char_line_count}" 
+          elsif c.eql?("}") && open_blocks.any?
+            opening=open_blocks.pop
+            puts "Block at opening: LN=#{opening[0]} CN=#{opening[1]}"
+            puts "Block closed at: LN=#{line_count} CN=#{char_line_count}"
+          end
+          char_line_count+=1
+        end
+        line_count+=1
+    end
+  end
+  
+  def find_citations (text)
+    if text.is_a?(String)
+      text=text
+    elsif text_is_a?(Array)
+      text=text.join
+    end
+  end
+

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: hard_citer
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Michael Cordell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-18 00:00:00.000000000 Z
+dependencies: []
+description: ! "\nHard Citer is a solution for outputting HTML bibliographies. When
+  used\nin conjuction with a \"cite while you write\" tool, it can make writing and\nediting
+  well-cited html eaiser. This may be particularly useful for \nacademics publishing
+  online. Using a in-text cited HTML document and\na bibtex library, it can output
+  a properly formatted bibliography.\n"
+email:
+- surpher@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- LICENSE.txt
+- lib/hard_citer.rb
+- lib/hardciter/bibliography.rb
+- lib/hardciter/cite_match.rb
+- lib/hardciter/citer.rb
+- lib/hardciter/configuration.rb
+- lib/hardciter/document.rb
+- lib/hardciter/exceptions.rb
+- lib/hardciter/library.rb
+- lib/hardciter/styler.rb
+- lib/scrap_methods
+homepage: https://github.com/mcordell/hard_citer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A gem to help with in-text citations in HTML documents.
+test_files: []
+has_rdoc: