sweetie 0.1.2 → 1.0.0

data/.gitignore

@@ -3,4 +3,3 @@
 *.gem
 *.sass-cache
 .yardoc/*
-sweetie

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--color
+

data/.travis.yml

@@ -1,2 +1,3 @@
-rvm:
-  - 1.9.1
+rbenv:
+  - 1.9.2-p290
+

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sweetie.gemspec
+gemspec
+

data/README.md

@@ -1,26 +1,83 @@
-Sweetie is a plugin for [jekyll](https://github.com/mojombo/jekyll) to count all links, images, pages, and the last build time on a jekyll site. You can then use this information at a any place in your jekyll project.
+Sweetie is a plugin for [jekyll](https://github.com/mojombo/jekyll) to count all links, images,
+pages, and the last build time on a jekyll site. You can then use this information at a any place in
+your jekyll project.[![Travis](http://travis-ci.org/matthias-guenther/sweetie.png)](http://travis-ci.org/matthias-guenther/sweetie)
 
 
-## Configuration variables
-To get the plugin working you must add `build`, `htmlpages`, `images`, and `links` in your `_config.yml` file. _sweetie_ will save the information to this variables. You can then use them everywhere in your page with the liquid snippet for example: 
+## Installation ##
 
-* `{{ site.build }}`
-* `{{ site.htmlpages }}`
-* `{{ site.images }}`
-* `{{ site.links }}`
+    gem install sweetie
 
-on all of your pages.
 
+## Possible usage ##
 
-## Installation
-Put the `sweetie.rb` file in the root of your jekyll project and then run the file to update your `_config.yml`file. To get the right calculated number of html pages, your pages must have the file ending *.html.
+The easiest way is to add `require 'sweetie'` on the top of your Rakefile.
 
+Before you build your page, you can run a rake task to update the status information of a page:
 
-## Possible usage
-Before you deploy your page, you can run the `sweetie.rb` in a rake task:
+    desc 'write stats in the _config.yml'
+    task :create_stati do
+      Sweetie::Conversion.conversion
+    end
 
-	desc "deploy"
-	task :create_stati do
-	  system("sweetie")
-	end
+A similar task can be implemented for the bitbucket repositories:
+
+    desc 'write stats in the _config.yml'
+    task :create_bitbucket do
+      Sweetie::Bitbucket.bitbucket("yourname")
+    end
+
+
+## Configuration variables of jekyll ##
+
+Call the class method `Sweetie::Bitbucket.bitbucket("yourname")` and it will automatically append
+the `build`, `htmlpages`, `images`, and `links` in your `_config.yml` file. You can then use them
+everywhere in your page with the liquid snippet for example:
+
+- `{{ site.build }}`
+- `{{ site.htmlpages }}`
+- `{{ site.images }}`
+- `{{ site.links }}`
+
+
+## Last changes of bitbucket repository ##
+
+Call the class method `Sweetie::Bitbucket.bitbucket("yourname")` and it will automatically append
+the repository name an the last change of the repository in your `_config.yml`. Here is an example:
+
+    git: 2011-10-16
+    pmwiki-twitter-recipe: 2011-10-29
+
+You can then use this variables in the view of your jekyll project with the liquid template. For
+example:
+
+    ### git ###
+
+    <section class="lastupdate">
+    Last update {{ site.git }}
+    </section>
+    ...
+
+
+    ### Twitter ###
+
+    <section class="lastupdate">
+    Last update {{ site.pmwiki-twitter-recipe }}
+    </section>
+    ...
+
+will result the following html:
+
+
+    <h3 id="git">Git</h3>
+
+    <section class="lastupdate">
+    Last update 2011-10-16
+    </section>
+
+
+    <h3 id="twitter">Twitter</h3>
+
+    <section class="lastupdate">
+    Last update 2011-10-16
+    </section>
 

data/lib/sweetie.rb

@@ -1,7 +1,6 @@
 require 'sweetie/conversion'
+require 'sweetie/bitbucket'
 
 module Sweetie
-  VERSION = '0.1.2'
-  DATE = '2011-07-17'
-end
 
+end

data/lib/sweetie/bitbucket.rb

@@ -0,0 +1,143 @@
+module Sweetie
+  require 'sweetie/helper'
+
+  class Bitbucket
+    require 'json'
+    @@config = "_config.yml"
+
+    class << self
+      include Sweetie::Helper
+
+      # getter for class variable @@config
+      def config
+        @@config
+      end
+
+      # setter for the class variable @@config
+      def config=(config)
+        @@config = config
+      end
+
+      # Wrapper to start all the other methods
+      # @param [user] a valid bitbucket user
+      def bitbucket(user)
+        # json represetnation of user repositories
+        json_repositories = get_repositories_json(user)
+
+        # get the names of the repositories
+        repositories_names = read_repositories(json_repositories)
+
+        # get the hash with repository-name and last changes
+        repositories_changes_hash = repositories_changes(user, repositories_names)
+
+        # write the repository information in the _config.yml
+        write_repository_changes(repositories_changes_hash)
+      end
+
+      # names of all repositories of a user
+      # @param [json_repositories] repositories in json format
+      # @return array with the names of all repositories of the user
+      def read_repositories(json_repositories)
+        repository_hash = parse_json(json_repositories)
+        repositories_names = []
+
+        repository_hash["repositories"].each do |repo|
+          repositories_names << repo["slug"]
+        end
+
+        repositories_names
+      end
+
+      # Get the last changes for each repository and the name
+      # @param [user] a valid bitbucket user
+      # @param [repositories] array with names of all repositories of a user
+      # @return hash with all the repositories of the user and the last changes
+      def repositories_changes(user, repositories)
+        repositories_lastmodifications = {}
+        repositories.each do |repository|
+          changeset = repository_changeset(user, repository)
+          repositories_lastmodifications.merge(repository_last_modification(repository, changeset))
+        end
+
+        repositories_lastmodifications
+      end
+
+      # Get the last modification of a repository
+      # @param [repository_name] a valid repository name
+      # @param [repository_json] json representation of the repository
+      def repository_last_modification(repository_name, repository_json)
+        changeset_parsed = parse_json(repository_json)
+        timestamp = changeset_parsed["changesets"].last["timestamp"]
+
+        # create the hash
+        {repository_name => parse_timestamp(timestamp)}
+      end
+
+      # Parse JSON file to format be read by ruby
+      def parse_json(file)
+        JSON.parse file
+      end
+
+      # Get the changeset of a repository
+      # @param [user] a valid bitbucket user
+      # @param [repository] a repository of a user
+      # @return information about the repository in json
+      def repository_changeset(user, repository)
+        `curl -s https://api.bitbucket.org/1.0/repositories/#{user}/#{repository}/changesets/`
+      end
+
+      # Get the json representation of each repository of the user
+      # @param [user] a valid bitbucket user
+      # @return json representation of all bitbucket repositories
+      def get_repositories_json(user)
+        `curl -s https://api.bitbucket.org/1.0/users/#{user}/`
+      end
+
+      # Parse timestamp to display only the date ("2011-04-20 11:31:39" will be converted to "2011-04-20")
+      # @param [timestamp] a time display as a string in the 'Time.now' format
+      # @return "yyyy-mm-dd"
+      def parse_timestamp(timestamp)
+        regex = Regexp.new(/(\d+)-(\d+)-(\d+)/)
+        regex.match(timestamp)[0]
+      end
+
+      # Writes the changes into the _config.yml
+      # @param [repositories] a hash with the following scheme {"svn" => "2011-10-26", "pmwiki" => "2011-10-26"}
+      def write_repository_changes(repositories)
+        repositories.each do |repository, last_change|
+          file = File.open(@@config)
+          text = ""
+          match = false
+          while line = file.gets
+            if line.match(/#{repository}/)
+              match = true
+              # create string and replace this line with the new changes
+              text << create_entry(repository, last_change) + "\n"
+            else
+              text << line
+            end
+          end
+
+          # append the repository if it is not in there
+          text << create_entry(repository, last_change) unless match
+
+          file.close
+
+          write_config(@@config, text)
+        end
+      end
+
+      # Create a string representation of a repository entry
+      # @param [repository_name] string contains the name of the repository
+      # @param [last_change] string contains the date of the change
+      # @return a string in the form "<reponame>: <date>"
+      def create_entry(repository_name, last_change)
+        "#{repository_name}: #{last_change}"
+      end
+
+    end
+
+  end
+
+end
+

data/lib/sweetie/conversion.rb

@@ -0,0 +1,86 @@
+module Sweetie
+  require 'nokogiri'
+  require 'sweetie/helper'
+
+  class Conversion
+
+    class << self
+
+      @@config = "_config.yml"
+      @@dir    = "_site"
+
+
+      include Sweetie::Helper
+
+      # Opens the config file and search after the specified parameters.
+      # It saves the gathered information about the build-date, the links,
+      # the images, and the number of html-pages in the jekyll project.
+      def conversion
+        check_config_and_directory_file(@@config, @@dir)
+
+        file = File.open(@@config)
+        text = ""
+        while line = file.gets
+          if line.match(/build:/)
+            text << "build: #{build_time}\n"
+          elsif line.match(/htmlpages:/)
+            text << "htmlpages: #{count_all_html_pages(@@dir)}\n"
+          elsif line.match(/images:/)
+            text << "images: #{count_all_images(@@dir)}\n"
+          elsif line.match(/links:/)
+            text << "links: #{count_all_links(@@dir)}\n"
+          else
+            text << line
+          end
+        end
+        file.close
+
+        write_config(file, text)
+      end
+
+      # Counts the link of on html page
+      # @param [page] the path of a html page
+      # @return the number of unique links
+      def count_link_of_one_page(page)
+        perform_search_for_single_page('//a', [], page)
+      end
+
+      # Count the images of one html page
+      # @param (see #self.count_link_of_one_page)
+      # @return the number of unique images
+      def count_images_of_one_page(page)
+        perform_search_for_single_page('//img', [], page)
+      end
+
+      # Counts all html pages
+      # @param [Dir] the path of the directory
+      # @return [Fixnum] the number of unique html pages
+      def count_all_html_pages(dir)
+        perform_global_search('//html', [], dir)
+      end
+
+      # Counts all the links of all html pages
+      # @param (see #self.count_all_html_pages)
+      # @return (see #self.count_all_html_pages)
+      def count_all_links(dir)
+        perform_global_search('//a', [], dir)
+      end
+
+      # Counts all the images of all html pages
+      # @param (see #self.count_all_html_pages)
+      # @return (see #self.count_all_html_pages)
+      def count_all_images(dir)
+        perform_global_search('//img', [], dir)
+      end
+
+      # Create the actual build time
+      # @return [String] in the date format mm-dd-yyyy
+      def build_time
+        time = Time.now
+        "#{time.month}-#{time.day}-#{time.year}"
+      end
+    end
+  end
+
+end
+

data/lib/sweetie/helper.rb

@@ -0,0 +1,85 @@
+module Sweetie
+
+  module Helper
+
+    # Traverse the page after the pattern and return the number of occurences on it
+    # @param [pattern] need for nokogiri to parse the html page
+    # @param [array] array to save the results
+    # @param [page] a single page which will be taken for the search
+    def perform_search_for_single_page(pattern, array, page)
+      harvest(pattern, page, array)
+      output_count(array)
+    end
+
+    # Traverse the dir after the pattern and return the number of occurences in the pages
+    # @param [pattern] need for nokogiri to parse the html page
+    # @param [array] array to save the results
+    # @param [dir] the main directory in which the by jekyll generated files are stored
+    def perform_global_search(pattern, array, dir)
+      traverse(pattern, array, dir)
+      output_count(array)
+    end
+
+    # Traverse the jekyll directory and get the information about a specific pattern
+    # @param [pattern] is a string for nokogiri after which the html pages should be parsed
+    # @param [ar] is an empty Array which is used by the harvest method
+    # @param [dir] the directory in which the html files are stored
+    def traverse(pattern, ar, dir)
+      Dir.glob(dir+"/**/*") do |file|
+        next if file == '.' or file == '..' or file.include?("html~")
+        if file.match(/(.*).html/)
+          harvest(pattern, file, ar)
+        end
+      end
+    end
+
+    # Traverse each html page and gather information about the specified html element
+    # @param [pattern] important for nokogiri
+    # @param [html] the path for the html file
+    # @param [ar] and array which stores all the findings produces by nokogiri
+    def harvest(pattern, html, ar)
+      file = File.open(html)
+      doc = Nokogiri::HTML(file)
+      doc.xpath(pattern).each do |node|
+        if pattern == "//a"
+          ar << node.text
+        elsif pattern == "//img" and ar.include?(node.to_s)
+        elsif pattern == "//img"
+          ar << node.to_s
+        elsif pattern == "//html"
+          ar << node
+        else
+        end
+      end
+      ar
+    end
+
+    # Count the elements
+    # @param [ar] is an array with all the found html parts
+    def output_count(ar)
+      ar.uniq.count # remove duplicates with uniq
+    end
+
+    # Write in the file the text
+    # @param [file] is the _config.yml file of the jekyll project
+    # @param [text] is a multiline string which will be written in the file
+    def write_config(file, text)
+      File.open(file, 'w') do |file|
+        file.puts text
+        file.close
+      end
+    end
+
+    # Check the existence of needed files for sweetie
+    # @param [config] the _config.yml file
+    # @param [dir] the directory of the generated jekyll page
+    def check_config_and_directory_file(config, dir)
+      if !File.exist? config or !Dir.exist? dir
+        raise "Can't find the _config.yml or the _site directory! Please create these files it!"
+      end
+    end
+
+  end
+
+end
+