RubyGems - referencess - Versions diffs - 0.1.0 - Mend

referencess 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

checksums.yaml +7 -0
data/.coveralls +1 -0
data/.gitignore +10 -0
data/.rspec +2 -0
data/.travis.yml +8 -0
data/CODE_OF_CONDUCT.md +13 -0
data/Gemfile +4 -0
data/Guardfile +82 -0
data/LICENSE.txt +21 -0
data/README.md +38 -0
data/Rakefile +7 -0
data/bin/console +14 -0
data/bin/setup +7 -0
data/doc/References.html +146 -0
data/doc/References/Book.html +410 -0
data/doc/References/Ebook.html +362 -0
data/doc/References/List.html +822 -0
data/doc/References/Magazine.html +376 -0
data/doc/References/Name.html +559 -0
data/doc/References/Node.html +408 -0
data/doc/References/Reference.html +1421 -0
data/doc/_index.html +199 -0
data/doc/class_list.html +58 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +339 -0
data/doc/file.README.html +124 -0
data/doc/file_list.html +60 -0
data/doc/frames.html +26 -0
data/doc/index.html +124 -0
data/doc/js/app.js +219 -0
data/doc/js/full_list.js +181 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +315 -0
data/doc/top-level-namespace.html +112 -0
data/lib/references.rb +13 -0
data/lib/references/book.rb +36 -0
data/lib/references/ebook.rb +24 -0
data/lib/references/list.rb +113 -0
data/lib/references/magazine.rb +27 -0
data/lib/references/name.rb +25 -0
data/lib/references/reference.rb +143 -0
data/lib/references/version.rb +3 -0
data/references.gemspec +29 -0
metadata +187 -0

data/doc/top-level-namespace.html ADDED

@@ -0,0 +1,112 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.7.6
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!top-level-namespace.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="References.html" title="References (module)">References</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Tue Dec 15 21:21:43 2015 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.2.3).
+</div>
+  </body>
+</html>

data/lib/references.rb ADDED

@@ -0,0 +1,13 @@
+require 'references/version'
+require 'references/reference'
+require 'references/list'
+require 'references/ebook'
+require 'references/magazine'
+require 'references/book'
+require 'references/name'
+# This module let define your references using a DSL. Into it you can find:
+# * A List to represent a ordered set of references, that can be format to APA standard.
+# * References to a book, magazine and ebook(e-documents)
+module References
+end

data/lib/references/book.rb ADDED

@@ -0,0 +1,36 @@
+# coding: utf-8
+require "references"
+module References
+  # Represent a book reference
+  class Book < Reference
+    # Format book reference to APA standard
+    # @return [String] format output
+    def formatAPA
+      (prettyOutput(@authors.map { |x| x.to_s }) + "(" + @datee.year.to_s + ") " + @title +
+        if @subtitle
+          ": " + @subtitle + "."
+        else
+          ""
+        end +
+       "\n\t"+@serie+". (" + @edition.to_s + ") " +
+       "(" + @editionnumber.to_s + ") " +
+       @isbn.join(", "))
+    end
+    # Set subtitle of document
+    # params subtitle [String]
+    def subtitle(subtitle)
+      @subtitle = subtitle
+    end
+    # Set some isbn of document, each isbn is store in a list, you can have some in the same book
+    # params isbn [String]
+    def isbn(isbn)
+      if @isbn.nil?
+        @isbn = []
+      end
+      @isbn << isbn
+    end
+  end
+end

data/lib/references/ebook.rb ADDED

@@ -0,0 +1,24 @@
+# coding: utf-8
+require "references"
+require "date"
+module References
+  # Represents a e-document
+  class Ebook < Reference
+    attr_accessor :url
+    # Format book reference to APA standard
+    # @return [String] format output
+    def formatAPA
+      (prettyOutput(@authors.map { |x| x.to_s }) + "(" + @datee.year.to_s + ") " + @title +
+       "\n\t(" + @edition.to_s + ") " +
+       "(" + @editionnumber.to_s + ") " +
+       @url)
+    end
+    # Set the url from get the source of document
+    # @param url [String] URL of source
+    def url(url)
+      @url = url
+    end
+  end
+end

data/lib/references/list.rb ADDED

@@ -0,0 +1,113 @@
+module References
+	# Struct of a list
+	Node = Struct.new(:value, :next, :back)
+  # Is a double-linked list
+	class List
+    include Enumerable
+		def initialize(*vals)
+			if vals.length == 0
+				@head = nil
+				@last = nil
+			else
+				for val in vals do
+					pushEnd val
+				end
+			end
+		end
+    def each
+      aux = @head
+      while aux != nil
+        yield aux.value
+        aux = aux.next
+      end
+    end
+		def takeFirst
+			if (@head==@last)
+        if @head == nil
+        	return nil
+        end
+        value = @head.value
+        @head = nil
+        @last = nil
+        return value
+   	  else
+        value = @head.value
+        @head = @head.next
+        @head.back = nil
+        return value
+      end
+		end
+    def takeLast
+			if (@head==@last)
+        if @last == nil
+        	return nil
+        end
+        value = @last.value
+        @head = nil
+        @last = nil
+        return value
+   	  else
+        value = @last.value
+        @last = @last.back
+        @last.next = nil
+        return value
+      end
+    end
+		def put(val)
+			if @head == nil
+				@head = @last = Node.new(val,nil,nil)
+			else
+				aux = Node.new(val,@head, nil)
+				@head.back = aux
+				@head = aux
+			end
+			nil
+		end
+    def pushEnd(val)
+      if @last==nil
+				@head = @last = Node.new(val,nil,nil)
+			else
+				aux = Node.new(val,nil,@last)
+				@last.next = aux
+				@last = aux
+			end
+			nil
+    end
+		def length
+			aux = @head
+			count = 0
+			while aux!=nil
+				count = count + 1
+				aux = aux.next
+			end
+			count
+		end
+		def head
+			if @head != nil
+				@head.value
+			else
+				nil
+			end
+		end
+    def last
+			if @last != nil
+				@last.value
+			else
+				nil
+			end
+		end
+    def to_s
+      (self.sort.map { |x| x.formatAPA }).join("\n")
+    end
+	end
+end

data/lib/references/magazine.rb ADDED

@@ -0,0 +1,27 @@
+# coding: utf-8
+require "references"
+module References
+  class Magazine < Reference
+    def initialize(&block)
+      instance_eval &block
+      @title = @title.split(" ").map { |x| if x.length >= 4 then x[0].upcase + x[1..-1] end }.join(" ")
+    end
+    def issbn(issbn)
+      if @issbn.nil?
+        @issbn = []
+      end
+      @issbn << issbn
+    end
+    # Format book reference to APA standard
+    # @return [String] format output
+    def formatAPA
+      (prettyOutput(@authors.map { |x| x.to_s }) + "(" + @datee.year.to_s + ") " + @title +
+       "\n\t(" + @edition.to_s + ") " +
+       "(" + @editionnumber.to_s + ") " +
+       @issbn.join(", "))
+    end
+  end
+end

data/lib/references/name.rb ADDED

@@ -0,0 +1,25 @@
+# coding: utf-8
+module References
+  # This class let work internal names of authors of a fancy way.
+  class Name
+    include Comparable
+    attr_reader :surnames, :names
+    # Make a Name object
+    # @param surnames [String] Take string with surnames of person of interest seperated with spaces.
+    # @param names [String] Take string with names of person of interest seperated with spaces.
+    def initialize(surnames, names)
+      @surnames = surnames.split(" ")
+      @names = names.split(" ")
+    end
+    # Define the comparasion of names, in this case is with the first surname.
+    def <=>(other)
+      other.surnames.first <=> @surnames.first
+    end
+    # Let convert a Name object in a human readable String in fancy way too.
+    # @return [String]
+    def to_s
+      @surnames.first + ", " + (@names.map { |x| x[0].upcase }).join(". ") + ". "
+    end
+  end
+end

data/lib/references/reference.rb ADDED

@@ -0,0 +1,143 @@
+# coding: utf-8
+ module References
+  # Represent references to resources in a document, it can be e-documents
+  # papers, book and also magazines.
+  # To create a #Reference you need know the DSL to make, is so simple:
+  # @example
+  #  @libro = References::Book.new do
+  #   author :surnames => "Thomas",
+  #         :names    => "Dave"
+  #   author :surnames => "Hunt",
+  #          :names    => "Andy"
+  #   author :surnames => "Chad",
+  #          :names    => "Fowler"
+  #
+  #   title "Programming Ruby 1.9 & 2.0"
+  #   subtitle "The Pragmatic Programmers’ Guide"
+  #   editorial :serie =>  "The Facets of Ruby",
+  #             :edition => "Pragmatic Bookshelf",
+  #             :editionnumber => 4
+  #
+  #   date :year => 2013, :month => 7, :day => 7
+  #
+  #   isbn "ISBN-13: 978-1937785499"
+  #   isbn "ISBN-10: 1937785491"
+  # end
+  class Reference
+    include Comparable
+    attr_accessor :authors, :datee
+    # Take a block
+    def initialize(&block)
+      instance_eval &block
+    end
+    # Let, set a author/s in a Reference. You can define some authors, only calling this n-repeated times
+    # @param hash [String]
+    def author(hash)
+      if @authors.nil?
+        @authors = []
+      end
+      @authors << References::Name.new(hash[:surnames], hash[:names])
+    end
+    # A Reference only can have a title. If you call this function twice times this, overwrite the las value
+    # @param title [String]
+    def title(title)
+      @title = title
+    end
+    # A Reference only can have a editorial. If you call this function twice times, this overwrite the las value
+    # The hash must have a :serie => String, :edition => String, :editionnumber => Number
+    # @param editorial [Hash]
+    def editorial(editorial)
+      @serie = editorial[:serie]
+      @edition = editorial[:edition]
+      @editionnumber = editorial[:editionnumber]
+    end
+    # A Reference only can have a date. If you call this function twice times, this overwrite the las value
+    # The hash must have a :year => Number, :month => Number, :day => Number
+    # @param date [Hash]
+    def date(date)
+      @datee = Date.new(date[:year],date[:month],date[:day])
+    end
+    # This function let format a array to prettitied its output adding a '&' before to last element.
+    # @param array [List]
+    # @return String
+    def prettyOutput(array)
+      if array.length > 1
+        array[0..-2].join("") + " & " + array[-1]
+      elsif array.length == 1
+        array[0]
+      else
+        ""
+      end
+    end
+    # Define the method to compare several Reference objects
+    def <=>(other)
+      int = other.authors <=> @authors
+      if int = 0
+        int = other.datee <=> @datee
+      end
+      int
+    end
+    # Cuantity of authors set
+    def cantidadAuthors()
+      @authors.length()
+    end
+    # Is have set a title?
+    def hasTitle
+      if @title then
+        true
+      else
+        false
+      end
+    end
+    def cantidadSeries
+      if @serie!= nil then
+        1
+      else
+        0
+      end
+    end
+    def hasEdition
+      if @edition then
+        true
+      else
+        false
+      end
+    end
+    def hasEditionnumber
+      if @editionnumber then
+        true
+      else
+        false
+      end
+    end
+    def hasDate
+      if @datee then
+        true
+      else
+        false
+      end
+    end
+    def cantidadIsbn
+      @isbn.length
+    end
+    # Not specification in the Reference abstract class
+    def formatAPA
+      "Not format abstract class"
+    end
+  end
+end