sweetie 0.1.2 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1db059c1e669df16935ce777d10950815b50a92f5358cf9b5a85d1a62c9ab5a
+  data.tar.gz: d4f75478d20b6a6d5a0c2394c40d1b4c01a8bd406775c00fc866f969eb4c85f4
+SHA512:
+  metadata.gz: 844e97b5dd14342c2e7119fa03d88a95527adcb6ac08ce65041f44eb7239262ab9251ac06baead2766b9eb25b5db0396a634e2fd12dfa33ae9a3e229f2b321b1
+  data.tar.gz: 0a4bc5e88a63a34103fb34bf225d462b541326350553fd7af76412e1e310f0af90378cc1694ba697419c3879622665305061c57950ff0fc8b527afb8ef674419

data/.circleci/config.yml

@@ -0,0 +1,30 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+jobs:
+  build:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: circleci/ruby:<< parameters.ruby-version >>
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: gem install bundler:2.2.26
+      - ruby/bundle-install
+      - run:
+          name: Run rspec tests
+          command: bundle exec rspec
+workflows:
+  build_and_test:
+    jobs:
+      - build:
+          matrix:
+            parameters:
+              # https://github.com/CircleCI-Public/cimg-ruby
+              # only supports the last three ruby versions
+              ruby-version: ["2.6.0", "2.6.5", "2.7.4", "3.0.2"]

data/.gitignore

@@ -3,4 +3,7 @@
 *.gem
 *.sass-cache
 .yardoc/*
-sweetie
+Gemfile.lock
+doc/
+bin/
+.mucksrc

data/.rubocop.yml

@@ -0,0 +1,16 @@
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 150
+Metrics/BlockLength:
+  Max: 150
+
+Layout/TrailingBlankLines:
+  EnforcedStyle: final_blank_line
+
+Style/RedundantSelf:
+  Enabled: false
+Style/HashSyntax:
+  EnforcedStyle: no_mixed_keys
+

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'pry'
+
+gemspec
+

data/README.md

@@ -1,26 +1,303 @@
-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 to get statistics for [jekyll](http://jekyllrb.com/ "jekyll") and
+[middleman](https://middlemanapp.com/ "middleman") projects. The statistics includes the unique number of all links,
+images, pages, and the last build time of the given project. You can specify the location the generated files
+(normally `_site` for jekyll and `build` for middleman apps) and of the `config` file where the changes
+will be written.
 
 
-## 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: 
+It can also grab the last changes of your bitbucket repositories. You can then use the information on various places in
+your project
 
-* `{{ site.build }}`
-* `{{ site.htmlpages }}`
-* `{{ site.images }}`
-* `{{ site.links }}`
+[![Gem Version](https://badge.fury.io/rb/sweetie.svg)](http://badge.fury.io/rb/sweetie)
+[![CircleCI](https://circleci.com/gh/wikimatze/sweetie.svg?style=svg)](https://app.circleci.com/pipelines/github/wikimatze/sweetie)
 
-on all of your pages.
+
+## Toc
+
+- [Installation](#installation)
+- [Usage create stati](#usage-create-stati)
+  - [Jekyll](#jekyll "Jekyll projects")
+  - [Configuration variables for Jekyll](#configuration-variables-for-jekyll "Configuration variables for Jekyll")
+  - [Middleman](#middleman "Middleman projects")
+  - [Configuration variables for Middleman](#configuration-variables-for-middleman "Configuration variables for Middleman")
+- [Usage bitbucket repositories](#usage-bitbucket-repositories "Usage bitbucket repositories")
+  - [Middleman](#middleman-1 "Middleman")
+  - [Jekyll](#jekyll-1 "Jekyll")
 
 
 ## 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.
 
+```sh
+$ gem install sweetie
+```
+
+
+## Usage create stati
+
+### Jekyll
+
+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:
+
+
+```ruby
+require 'sweetie'
+
+desc 'write stats in the _config.yml file'
+task :create_stati do
+  sweetie = Sweetie::Conversion.new('./site', './_config.yml')
+  sweetie.create_stati
+end
+```
+
+
+Make sure that the following fields are set in your `_config.yml`:
+
+
+```yml
+build:
+htmlpages:
+images:
+links:
+```
+
+
+After running the script, the changes in `_config.yml` will look like:
+
+
+```ruby
+build: 6-18-2017
+htmlpages: 600
+images: 20
+links: 271
+```
+
+
+### Configuration variables for Jekyll
+
+You can use the `build`, `htmlpages`, `images`, and `links` variables defined in your `_config.yml` file everywhere in your page with the liquid snippet for example:
+
+
+- `{{ site.build }}`
+- `{{ site.htmlpages }}`
+- `{{ site.images }}`
+- `{{ site.links }}`
+
+
+If you also make use of [Usage for Bitbucket repositories](#usage-for-bitbucket-repositories "Usage for Bitbucket repositories") you can also use the last update value for your repositories:
+
+
+```html
+<section class="lastupdate">
+Last update {{ site.git }}
+</section>
+...
+
+
+<section class="lastupdate">
+Last update {{ site.pmwiki-twitter-recipe }}
+</section>
+...
+```
+
+
+will result the following html:
+
+
+```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>
+```
+
+
+
+### Middleman
+
+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:
+
+
+```ruby
+require 'sweetie'
+
+desc 'write stats in the config.rb file'
+task :create_stati do
+  sweetie = Sweetie::Conversion.new('./build', './config.rb')
+  sweetie.create_stati
+end
+```
+
+
+Make sure that the following fields are set in your `config.rb`:
+
+
+```yml
+set :build,
+set :images,
+set :htmlpages,
+set :links,
+```
+
+
+After running the script, the changes in `config.rb` will look like for example:
+
+
+```ruby
+set :build, 6-18-2017
+set :images, 75
+set :htmlpages, 111
+set :links, 694
+```
+
+
+### Configuration variables for Middleman
+
+You can use the `build`, `htmlpages`, `images`, and `links` variables defined in your `_config.yml` file everywhere in your page with the erb snippet for example:
+
+
+- `<%= config[:build] %>
+- `<%= config[:htmlpages] %>
+- `<%= config[:images] %>
+- `<%= config[:links] %>
+
+
+If you also make use of [Usage for Bitbucket repositories](#usage-for-bitbucket-repositories "Usage for Bitbucket repositories") you can also use the last update value for your repositories:
+
+
+```html
+
+<section class="lastupdate">
+Last update <%= config[:git] %>
+</section>
+...
+
+
+<section class="lastupdate">
+Last update <%= config[:pmwiki_twitter_recipe %>
+</section>
+...
+```
+
+
+will result the following html:
+
+
+```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>
+```
+
+
+## Usage Bitbucket repositories
+
+### Middleman
+
+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 of the repositories for the given `config-file` and `username`:
+
+
+```ruby
+require 'sweetie'
+
+desc 'write repositories stats in the config.rb file'
+task :create_bitbucket do
+  stati_helper = Sweetie::BitbucketStatiHelper.new('./config.rb', 'wikimatze')
+  bitbucket = Sweetie::Bitbucket.new(stati_helper)
+  bitbucket.update_stati
+end
+```
+
+Please note that you have to change `wikimatze` to your bitbucket user name
+
+
+```ruby
+set :pmwiki_dropcaps_recipe,
+set :pmwiki_syntaxlove_recipe,
+set :pmwiki_twitter_recipe,
+set :pmwiki_linkicons_recipe,
+set :pmwiki_headlineimage_recipe,
+```
+
+
+After running the script, the names in `config.rb` above will be changed to:
+
+
+```ruby
+set :pmwiki_dropcaps_recipe, 2017-02-24
+set :pmwiki_syntaxlove_recipe, 2017-02-26
+set :pmwiki_twitter_recipe, 2017-02-26
+set :pmwiki_linkicons_recipe, 2017-02-26
+set :pmwiki_headlineimage_recipe, 2017-02-25
+```
+
+
+### Jekyll
+
+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 of the repositories for the given `config-file` and `username`:
+
+
+```ruby
+require 'sweetie'
+
+desc 'write repositories stats in the _config.yml file'
+desc 'write stats in the _config.yml'
+task :create_bitbucket do
+  stati_helper = Sweetie::BitbucketStatiHelper.new('./_config.yml', 'wikimatze')
+  bitbucket = Sweetie::Bitbucket.new(stati_helper)
+  bitbucket.update_stati
+end
+```
+
+Please note that you have to change `wikimatze` to your bitbucket user name
+
+
+```ruby
+set :pmwiki_dropcaps_recipe,
+set :pmwiki_syntaxlove_recipe,
+set :pmwiki_twitter_recipe,
+set :pmwiki_linkicons_recipe,
+set :pmwiki_headlineimage_recipe,
+```
+
+
+After running the script, the names in `config.rb` above will be changed to:
+
+
+```ruby
+set :pmwiki_dropcaps_recipe, 2017-02-24
+set :pmwiki_syntaxlove_recipe, 2017-02-26
+set :pmwiki_twitter_recipe, 2017-02-26
+set :pmwiki_linkicons_recipe, 2017-02-26
+set :pmwiki_headlineimage_recipe, 2017-02-25
+```
 
-## Possible usage
-Before you deploy your page, you can run the `sweetie.rb` in a rake task:
+## License
 
-	desc "deploy"
-	task :create_stati do
-	  system("sweetie")
-	end
+This software is licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License).
 
+© 2011-2019 Matthias Günther <matze@wikimatze.de>.

data/Rakefile

@@ -1,7 +1,8 @@
 task :spec do
-  Dir.glob("spec/**/*_spec.rb") do |file|
-    system ("rspec #{file}")
+  Dir.glob('spec/**/*_spec.rb') do |file|
+    system "rspec #{file}"
   end
 end
 
 task :default => :spec
+

data/lib/sweetie/bitbucket.rb

@@ -0,0 +1,30 @@
+require 'sweetie/helper'
+require 'sweetie/bitbucket_stati_helper'
+require 'json'
+
+module Sweetie
+  # The class to get the repositorie updates from Bitbucket
+  class Bitbucket
+    include Sweetie::Helper
+
+    # A basic initialize method.
+    #
+    # @param bitbucket_stati_helper [BitbucketStatiHelper]
+    # @return [BitbucketStatiHelper]
+    def initialize(bitbucket_stati_helper)
+      @bitbucket_stati_helper = bitbucket_stati_helper
+    end
+
+    # Wrapper to start all the other methods which will use methods
+    # to write the changes of the bitbucket in the config file,
+    # which can be configured in the BitbucketStatiHelper
+    #
+    # @return [nil]
+    def update_stati
+      json_repositories = @bitbucket_stati_helper.get_repositories
+      repositories_change_hashs = @bitbucket_stati_helper.get_repositories_changes(json_repositories)
+      @bitbucket_stati_helper.write_repository_changes(repositories_change_hashs)
+    end
+  end
+end
+

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
+