sweetie 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aaa05aba881687ee4bbda9e9c31574e54bb20fc3
-  data.tar.gz: 06a7b0afe7466ebac59a5c534e7b780d65e7bd5e
+SHA256:
+  metadata.gz: c1db059c1e669df16935ce777d10950815b50a92f5358cf9b5a85d1a62c9ab5a
+  data.tar.gz: d4f75478d20b6a6d5a0c2394c40d1b4c01a8bd406775c00fc866f969eb4c85f4
 SHA512:
-  metadata.gz: bab1e490132c38e57a363f9848e0ea47f2322dddf1ab1d34d8dd97b67546c4a44cc33ba0e3a649a275bb8969ffd6d83c6b13cb948ff1aa6d4fffff388bfb5c12
-  data.tar.gz: a22e2335b8f86a240af105fe8eaf0eaff1b30426c5e435e2e8f38964e2269f4e82f56a59e6deef1c7b6866c125d52ee85d7b19b8bd3c3655c979c564ac4b99ba
+  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

@@ -4,3 +4,6 @@
 *.sass-cache
 .yardoc/*
 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

@@ -1,5 +1,6 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "codeclimate-test-reporter", group: :test, require: nil
+gem 'pry'
 
 gemspec
+

data/README.md

@@ -1,6 +1,28 @@
-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. It can also grab the last changes of your bitbucket repositories.
-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.
+
+
+It can also grab the last changes of your bitbucket repositories. You can then use the information on various places in
+your project
+
+[![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)
+
+
+## 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
@@ -10,7 +32,9 @@ $ gem install sweetie
 ```
 
 
-## Usage
+## Usage create stati
+
+### Jekyll
 
 The easiest way is to add `require 'sweetie'` on the top of your Rakefile.
 
@@ -18,29 +42,42 @@ Before you build your page, you can run a rake task to update the status informa
 
 
 ```ruby
-desc 'write stats in the _config.yml'
+require 'sweetie'
+
+desc 'write stats in the _config.yml file'
 task :create_stati do
-  Sweetie::Conversion.conversion
+  sweetie = Sweetie::Conversion.new('./site', './_config.yml')
+  sweetie.create_stati
 end
 ```
 
 
-A similar task can be implemented for the bitbucket repositories:
+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
-desc 'write stats in the _config.yml'
-task :create_bitbucket do
-  Sweetie::Bitbucket.bitbucket("yourname")
-end
+build: 6-18-2017
+htmlpages: 600
+images: 20
+links: 271
 ```
 
 
-## Configuration variables of jekyll
+### 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:
 
-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 }}`
@@ -48,34 +85,107 @@ everywhere in your page with the liquid snippet for example:
 - `{{ site.links }}`
 
 
-## Last changes of bitbucket repository
+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>
+...
+```
 
-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:
+
+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
-git: 2011-10-16
-pmwiki-twitter-recipe: 2011-10-29
+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
 ```
 
 
-You can then use this variables in the view of your jekyll project with the liquid template. For example:
+### 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:
 
-```markdown
-### git
+
+- `<%= 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 {{ site.git }}
+Last update <%= config[:git] %>
 </section>
 ...
 
 
-### Twitter
-
 <section class="lastupdate">
-Last update {{ site.pmwiki-twitter-recipe }}
+Last update <%= config[:pmwiki_twitter_recipe %>
 </section>
 ...
 ```
@@ -100,8 +210,94 @@ Last update 2011-10-16
 ```
 
 
+## 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
+```
+
 ## License
 
 This software is licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License).
 
-© 2011-2015 Matthias Günther <matthias@wikimatze.de>.
+© 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

@@ -1,204 +1,29 @@
 require 'sweetie/helper'
+require 'sweetie/bitbucket_stati_helper'
+require 'json'
+
 module Sweetie
+  # The class to get the repositorie updates from Bitbucket
   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
-
-      # Public: Wrapper to start all the other methods
-      #
-      # user - The String of the bitbucket user
-      #
-      # Example:
-      #
-      #   bitbucket('wikimatze')
-      #
-      # Returns nothing but write the changes in the _config.yml file
-      def bitbucket(user)
-        json_repositories = get_repositories(user)
-        repositories_change_hashs = get_repositories_changes(json_repositories)
-        write_repository_changes(repositories_change_hashs)
-      end
-
-      # Public: Fire up curl request to bitbucket
-      #
-      # user - The String of the bitbucket user
-      #
-      # Example:
-      #
-      #   bitbucket('wikimatze')
-      #
-      #   # =>
-      #     {
-      #         "repositories": [
-      #             {
-      #                 "scm": "git",
-      #                 "has_wiki": false,
-      #                 "last_updated": "2012-07-01 07:03:08",
-      #                 "creator": null,
-      #                 "created_on": "2012-07-01 07:03:08",
-      #                 "owner": "wikimatze",
-      #                 "logo": null,
-      #                 "email_mailinglist": "",
-      #                 "is_mq": false,
-      #                 "size": 580,
-      #                 "read_only": false,
-      #                 "fork_of": null,
-      #                 "mq_of": null,
-      #                 "followers_count": 1,
-      #                 "state": "available",
-      #                 "utc_created_on": "2012-07-01 05:03:08+00:00",
-      #                 "website": "",
-      #                 "description": "",
-      #                 "has_issues": false,
-      #                 "is_fork": false,
-      #                 "slug": "knoppix-6-01",
-      #                 "is_private": false,
-      #                 "name": "knoppix-6-01",
-      #                 "language": "",
-      #                 "utc_last_updated": "2012-07-01 05:03:08+00:00",
-      #                 "email_writers": true,
-      #                 "no_public_forks": false,
-      #                 "resource_uri": "/1.0/repositories/wikimatze/knoppix-6-01"
-      #             },
-      #             ... other repositories
-      #             }
-      #         ],
-      #         "user": {
-      #             "username": "wikimatze",
-      #             "first_name": "Matthias",
-      #             "last_name": "Guenther",
-      #             "avatar": "https://secure.gravatar.com/avatar/208673d619b63131cbfd7205366ad16e?d=identicon&s=32",
-      #             "resource_uri": "/1.0/users/wikimatze"
-      #         }
-      #     }
-      #
-      # Returns a json representation the specified user
-      def get_repositories(user)
-        `curl -s https://api.bitbucket.org/1.0/users/#{user}/`
-      end
-
-      # Public: Grab for each repository the recent update
-      #
-      # json_repositories: A json object of the bitbucket API response
-      #
-      # Example:
-      #
-      #   get_repositories_changes(wikimatze_json)
-      #   # => {"pmwiki-headlineimage-recipe"=>"2011-10-29", "pmwiki-linkicons-recipe"=>"2011-10-29"}
-      #
-      # Returns a hash of the form {repository_name => last_updated}
-      def get_repositories_changes(json_repositories)
-        repository_hash = parse_json(json_repositories)
-        repositories_changsets = {}
-
-        repository_hash["repositories"].each do |repository|
-          repository_name = repository['name']
-          repository_last_updated = parse_timestamp(repository['last_updated'])
-          repositories_changsets.merge!({repository_name => repository_last_updated})
-        end
-
-        repositories_changsets
-      end
-
-      # Public: Wrapper for calling the json_parsing
-      #
-      # file: A String in JSON format
-      #
-      # 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"}}
-      #
-      # Returns Parse JSON file to format be read by ruby
-      def parse_json(json)
-        JSON.parse(json)
-      end
-
-      # Public: Parse a timestamp in a wanted format
-      #
-      # timestamp - A string in the form 2011-04-20 11:31:39
-      #
-      # Example:
-      #
-      #   parse_timestamp("2011-04-20 11:31:39")
-      #   # => 2011-04-20
-      #
-      # Returns a string in the format "yyyy-mm-dd"
-      def parse_timestamp(timestamp)
-        regex = Regexp.new(/(\d+)-(\d+)-(\d+)/)
-        regex.match(timestamp)[0]
-      end
-
-      # Public: Parse a hash and write its key/value pairs in a file
-      #
-      # repositories - A hash in the form {<name> => <last_updated}
-      #
-      # Example:
-      #
-      #   write_repository_changes({"svn" => "2011-10-26", "pmwiki" => "2011-10-26"})
-      #   # => svn: 2011-10-26\npmwiki: 2011-10-26
-      #
-      # Returns nothing but writes the information in the specified _config.yml file
-      def write_repository_changes(repositories)
-        repositories.each do |name, last_updated|
-          file = File.open(@@config)
-          text = ""
-          match = false
-          while line = file.gets
-            if line.match(/#{name}/)
-              match = true
-              # create string and replace this line with the new changes
-              text << entry_text(name, last_updated) + "\n"
-            else
-              text << line
-            end
-          end
-
-          # append the name if it is not in there
-          text << entry_text(name, last_updated) unless match
-
-          file.close
-          write_config(@@config, text)
-        end
-      end
+    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
 
-      # Public: Create a string representation of a repository entry
-      #
-      # name - A string containing the name of the repository
-      # last_updated - A string containing the date of the last change of the repo
-      #
-      # Example:
-      #
-      #   entry_text({"pmwiki" => "2011-10-26"}
-      #   # => "pmwiki: 2011-10-26"
-      #
-      # Return a string in the form "<name>: <last_updated>"
-      def entry_text(name, last_updated)
-        "#{name}: #{last_updated}"
-      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