sweetie 1.0.1 → 2.0.1

data/lib/sweetie/bitbucket_stati_helper.rb

@@ -0,0 +1,247 @@
+require 'sweetie/helper'
+require 'json'
+
+module Sweetie
+  # The class which do the actuall work to get and write the repositories updates in the config file
+  class BitbucketStatiHelper
+    include Sweetie::Helper
+
+
+    attr_writer :config, :user
+
+    # A basic initialize method.
+    #
+    # @param config [String] The config file in which the changes should be written
+    # @param user [String] The name of the user for which the updates should be fetched
+    # @return [nil]
+    def initialize(config = '_config.yml', user = '')
+      @config = config
+      @user = user
+    end
+
+    # Grab for each repository the recent update
+    #
+    # @param json_repositories [String]: A json object of the bitbucket API response
+    # @return [Hash] Returns a hash of the form {<repository_name> => <last_updated>}
+    #
+    # Example:
+    #
+    #   get_repositories_changes(wikimatze_json)
+    #   # => {"pmwiki-headlineimage-recipe"=>"2011-10-29", "pmwiki-linkicons-recipe"=>"2011-10-29"}
+    #
+    def get_repositories_changes(json_repositories)
+      repository_hash = parse_json(json_repositories)
+      repositories_changsets = {}
+
+      repository_hash['values'].each do |repository|
+        repository_name = repository['name']
+        repository_last_updated = parse_timestamp(repository['updated_on'])
+        repositories_changsets.merge!(repository_name => repository_last_updated)
+      end
+
+      repositories_changsets
+    end
+
+    # Wrapper for calling the json_parsing from JSON library
+    #
+    # @param json [String]: A JSON format from the bitbucket API response
+    # @return Returns Parse JSON file as a hash 2017-06-18
+    #
+    # Example:
+    #
+    #   json = {
+    #     "user": {
+    #       "username": "wikimatze",
+    #       "first_name": "Matthias",
+    #       "last_name": "Guenther",
+    #       "resource_uri": "/1.0/users/wikimatze"
+    #     }
+    #   }
+    #   parse_json(json)
+    #   => {"user"=>{"username"=>"wikimatze", "first_name"=>"Matthias", "last_name"=>"Guenther", "resource_uri"=>"/1.0/users/wikimatze"}}
+    #
+    def parse_json(json)
+      JSON.parse(json)
+    end
+
+    # Parse a hash and write its key/value pairs in a config file for jekyll and middleman projects
+    #
+    # @param repositories [Hash]- A hash in the form {<name> => <last_updated}
+    # @return [nil] Writes the of the repository hash specified _config.yml by the given @config variable
+    #
+    # Example:
+    #
+    #   write_repository_changes({"svn" => "2011-10-26", "pmwiki" => "2011-10-26"})
+    #   # => svn: 2011-10-26\npmwiki: 2011-10-26
+    def write_repository_changes(repositories)
+      repositories.each do |name, last_updated|
+        file = File.open(@config)
+        text = ''
+        project = 'middleman'
+
+        project = 'jekyll' if File.extname(file) =~ /.yml/
+
+        name = name.to_s.tr('-', '_')
+        while line = file.gets
+          text << if line =~ /#{name}/ && project == 'middleman'
+                    entry_text_middleman(name, last_updated) + "\n"
+                  elsif line =~ /#{name}/ && project == 'jekyll'
+                    entry_text_jekyll(name, last_updated) + "\n"
+                  else
+                    line
+                  end
+        end
+
+        file.close
+        write_config(@config, text)
+      end
+    end
+
+    # Parse a timestamp
+    #
+    # @param timestamp [String] A string in the form 2011-04-20 11:31:39
+    # @return [String] A string in the format "yyyy-mm-dd"
+    #
+    # Example:
+    #
+    #   parse_timestamp("2011-04-20 11:31:39")
+    #   # => 2011-04-20
+    #
+    def parse_timestamp(timestamp)
+      regex = Regexp.new(/(\d+)-(\d+)-(\d+)/)
+      regex.match(timestamp)[0]
+    end
+
+    # Create a string representation of a repository entry in middleman style
+    #
+    # @param name [String] A string containing the name of the repository
+    # @param updated [String] A string containing the date of the last change of the repo
+    # @return [String] Return a string in the form "set :<name> :<last_updated>"
+    #
+    # Example:
+    #
+    #   entry_text_middleman({"pmwiki" => "2011-10-26"}
+    #   # => "set :pmwiki 2011-10-26"
+    def entry_text_middleman(name, updated)
+      "set :#{name}, #{updated}"
+    end
+
+    # Create a string representation of a repository entry in jekyll style
+    #
+    # @param name [String] A string containing the name of the repository
+    # @param updated [String] A string containing the date of the last change of the repo
+    # @return [String] Return a string in the form "set :<name> :<last_updated>"
+    #
+    # Example:
+    #
+    #   entry_text_middleman({"pmwiki" => "2011-10-26"}
+    #   # => "pmwiki: 2011-10-26"
+    def entry_text_jekyll(name, updated)
+      "#{name}: #{updated}"
+    end
+
+    # Fire up curl request to bitbucket
+    #
+    # Example:
+    #
+    #   bitbucket('wikimatze')
+    #
+    #   # =>
+    #     {
+    #      "pagelen":10,
+    #      "values":[
+    #          {
+    #            "scm":"git",
+    #            "website":"",
+    #            "has_wiki":false,
+    #            "name":"pmwiki-linkicons-recipe",
+    #            "links":{
+    #               "watchers":{
+    #                  "href":"https://api.bitbucket.org/2.0/repositories/wikimatze/pmwiki-linkicons-recipe/watchers"
+    #               },
+    #               "branches":{
+    #                  "href":"https://api.bitbucket.org/2.0/repositories/wikimatze/pmwiki-linkicons-recipe/refs/branches"
+    #               },
+    #               "tags":{
+    #                  "href":"https://api.bitbucket.org/2.0/repositories/wikimatze/pmwiki-linkicons-recipe/refs/tags"
+    #               },
+    #               "commits":{
+    #                  "href":"https://api.bitbucket.org/2.0/repositories/wikimatze/pmwiki-linkicons-recipe/commits"
+    #               },
+    #               "clone":[
+    #                  {
+    #                     "href":"https://bitbucket.org/wikimatze/pmwiki-linkicons-recipe.git",
+    #                     "name":"https"
+    #                  },
+    #                  {
+    #                     "href":"ssh://git@bitbucket.org/wikimatze/pmwiki-linkicons-recipe.git",
+    #                     "name":"ssh"
+    #                  }
+    #               ],
+    #               "self":{
+    #                  "href":"https://api.bitbucket.org/2.0/repositories/wikimatze/pmwiki-linkicons-recipe"
+    #               },
+    #               "html":{
+    #                  "href":"https://bitbucket.org/wikimatze/pmwiki-linkicons-recipe"
+    #               },
+    #               "avatar":{
+    #                  "href":"https://bitbucket.org/wikimatze/pmwiki-linkicons-recipe/avatar/32/"
+    #               },
+    #               "hooks":{
+    #                  "href":"https://api.bitbucket.org/2.0/repositories/wikimatze/pmwiki-linkicons-recipe/hooks"
+    #               },
+    #               "forks":{
+    #                  "href":"https://api.bitbucket.org/2.0/repositories/wikimatze/pmwiki-linkicons-recipe/forks"
+    #               },
+    #               "downloads":{
+    #                  "href":"https://api.bitbucket.org/2.0/repositories/wikimatze/pmwiki-linkicons-recipe/downloads"
+    #               },
+    #               "pullrequests":{
+    #                  "href":"https://api.bitbucket.org/2.0/repositories/wikimatze/pmwiki-linkicons-recipe/pullrequests"
+    #               }
+    #            },
+    #            "fork_policy":"allow_forks",
+    #            "uuid":"{182b19dc-334d-40d7-a65d-a85aaeb46f31}",
+    #            "language":"",
+    #            "created_on":"2011-10-07T21:01:39.266805+00:00",
+    #            "mainbranch":{
+    #               "type":"branch",
+    #               "name":"master"
+    #            },
+    #            "full_name":"wikimatze/pmwiki-linkicons-recipe",
+    #            "has_issues":false,
+    #            "owner":{
+    #               "username":"wikimatze",
+    #               "display_name":"Matthias Günther",
+    #               "type":"user",
+    #               "uuid":"{5eab05fd-a541-43c5-a0e1-5bc9b2e2005f}",
+    #               "links":{
+    #                  "self":{
+    #                     "href":"https://api.bitbucket.org/2.0/users/wikimatze"
+    #                  },
+    #                  "html":{
+    #                     "href":"https://bitbucket.org/wikimatze/"
+    #                  },
+    #                  "avatar":{
+    #                     "href":"https://bitbucket.org/account/wikimatze/avatar/32/"
+    #                  }
+    #               }
+    #            },
+    #            "updated_on":"2017-02-26T07:09:52.048642+00:00",
+    #            "size":431470,
+    #            "type":"repository",
+    #            "slug":"pmwiki-linkicons-recipe",
+    #            "is_private":false,
+    #            "description":""
+    #          },
+    #         ...
+    #      ],
+    #    "page":1,
+    #    "size":9
+    #   }
+    def get_repositories
+      `curl -s https://api.bitbucket.org/2.0/repositories/#{@user}/`
+    end
+  end
+end
+

data/lib/sweetie/conversion.rb

@@ -1,85 +1,112 @@
-module Sweetie
-  require 'nokogiri'
-  require 'sweetie/helper'
+require 'nokogiri'
+require 'sweetie/helper'
 
+module Sweetie
+  # The class which can get the stati of the project including number of html pages, images, and links
   class Conversion
+    include Sweetie::Helper
 
-    class << self
-
-      @@config = "_config.yml"
-      @@dir    = "_site"
-
-      include Sweetie::Helper
+    # A basic initialize method.
+    #
+    # @param dir [String] The directoy in which should search after links, images and number of HTML pages
+    # @param config [String] The name of the config file in which the results should be written
+    # @return [nil]
+    def initialize(dir = '_site', config = '_config.yml')
+      @dir = dir
+      @config = config
+    end
 
-      # 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)
+    # It saves the gathered information about the build-date, the links,
+    # the images, and the number of html-pages in the jekyll project.
+    #
+    # @return [nil]
+    def create_stati
+      check_directory_and_config_file(@dir, @config)
 
-        file = File.open(@@config)
-        text = ""
+      file = File.open(@config)
+      text = ''
+      if File.extname(file) =~ /.rb/
         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
+          text << if line =~ /set :build,/
+                    "set :build, '#{build_time}'\n"
+                  elsif line =~ /set :htmlpages,/
+                    "set :htmlpages, #{count_all_html_pages(@dir)}\n"
+                  elsif line =~ /set :images,/
+                    "set :images, #{count_all_images(@dir)}\n"
+                  elsif line =~ /set :links,/
+                    "set :links, #{count_all_links(@dir)}\n"
+                  else
+                    line
+                  end
+        end
+      else
+        while line = file.gets
+          text << if line =~ /build:/
+                    "build: '#{build_time}'\n"
+                  elsif line =~ /htmlpages:/
+                    "htmlpages: #{count_all_html_pages(@dir)}\n"
+                  elsif line =~ /images:/
+                    "images: #{count_all_images(@dir)}\n"
+                  elsif line =~ /links:/
+                    "links: #{count_all_links(@dir)}\n"
+                  else
+                    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
+      file.close
 
-      # 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
+      write_config(file, text)
+    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 the link of on html page.
+    #
+    # @param page [String] The path of a html page
+    # @return [Integer] The number of unique links for the given page
+    def count_link_of_one_page(page)
+      perform_search_for_single_page('//a', [], page)
+    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
+    # Count the images of one html page.
+    #
+    # @param page [String] The path of a html page
+    # @return [Integer] The number of unique images for the given page
+    def count_images_of_one_page(page)
+      perform_search_for_single_page('//img', [], page)
+    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
+    # Counts all html pages for the given directory.
+    #
+    # @param dir [String] The path of the directory
+    # @return [Integer] The number of unique html pages
+    def count_all_html_pages(dir)
+      perform_global_search('//html', [], 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
+    # Counts all the links for the given directory.
+    #
+    # @param dir [String] The path of the directory
+    # @return [Integer] The number of unique links for the given dir
+    def count_all_links(dir)
+      perform_global_search('//a', [], dir)
+    end
+
+    # Counts all the images for the given directory.
+    #
+    # @param dir [String] The path of the directory
+    # @return [Integer] The number of all images for the given dir
+    def count_all_images(dir)
+      perform_global_search('//img', [], dir)
     end
-  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
 

data/lib/sweetie/helper.rb

@@ -1,68 +1,74 @@
 module Sweetie
-
+  # The Helper module which can get the stati of the project including number of html pages, images, and links
   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
+    #
+    # @param pattern [String] need for nokogiri to parse the html page
+    # @param arr [Array] array to save the results
+    # @param page [String] The path to a file which will be taken for the search
+    def perform_search_for_single_page(pattern, arr, page)
+      harvest(pattern, page, arr)
+      output_count(arr)
     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)
+    #
+    # @param pattern [String] The xpath regular for Nokogiri expressions after which the HTML is grabbed
+    # @param html [String] An array to save the results
+    # @param arr [Array] An array which stores all the findings produces by nokogiri
+    # @return [Array] The number of found results
+    def harvest(pattern, html, arr)
       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
+        if pattern == '//a'
+          arr << node.text
+        elsif pattern == '//img' && arr.include?(node.to_s)
+        elsif pattern == '//img'
+          arr << node.to_s
+        elsif pattern == '//html'
+          arr << node
         end
       end
-      ar
+      arr
     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
+    #
+    # @param arr [Array] An array with all the found html parts.
+    # @return [Integer] The number of uniq results in the given array.
+    def output_count(arr)
+      arr.uniq.count # remove duplicates with uniq
+    end
+
+    # Traverse the dir after the pattern and return the number of occurences in the pages
+    #
+    # @param pattern [String] The xpath regular for Nokogiri expressions after which the HTML is grabbed.
+    # @param arr [Array] array to save the results.
+    # @param dir [String] The main directory in which the search should be performed.
+    # @return [Integer] The number of found results.
+    def perform_global_search(pattern, arr, dir)
+      traverse(pattern, arr, dir)
+      output_count(arr)
+    end
+
+    # Traverse the jekyll directory and get the information about a specific pattern
+    #
+    # @param pattern [String] The xpath regular for Nokogiri expressions after which the HTML is grabbed.
+    # @param arr [Array] array to save the results.
+    # @param dir [String] The directory in which the html files are stored.
+    def traverse(pattern, arr, dir)
+      Dir.glob(dir + '/**/*') do |file|
+        next if file == '.' || file == '..' || file.include?('html~')
+        harvest(pattern, file, arr) if file =~ /(.*).html/
+      end
     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
+    #
+    # @param file [String] The path to the config file
+    # @param text [String] Is a multiline string of text
+    # @return [nil]
     def write_config(file, text)
       File.open(file, 'w') do |file|
         file.puts text
@@ -70,16 +76,15 @@ module Sweetie
       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
+    # Check the existence of given directory and config
+    #
+    # @param dir [String] The directory of the files.
+    # @param config [String] The path to the config file.
+    def check_directory_and_config_file(dir = '', config = '')
+      if !Dir.exist?(dir) || !File.exist?(config)
         raise "Can't find the _config.yml or the _site directory! Please create these files it!"
       end
     end
-
   end
-
 end
 

data/lib/sweetie/version.rb

@@ -1,4 +1,5 @@
 module Sweetie
-  VERSION = "1.0.1"
+  # A wrapper to current sweetie gem version
+  VERSION = '2.0.1'.freeze
 end
 

data/lib/sweetie.rb

@@ -1,6 +1,6 @@
 require 'sweetie/conversion'
 require 'sweetie/bitbucket'
 
-module Sweetie
+# The wrapper class for the gem
+module Sweetie; end
 
-end