between_meals 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,29 +1,22 @@
-# BetweenMeals
+# Between Meals
 
-TODO: Write a gem description
+## Intro
+Ohai!
 
-## Installation
+Between Meals is the library for calculating what Chef objects where modified
+between two revisions in a version control system. It is also the library
+that that backs Taste Tester and Grocery Delivery.
 
-Add this line to your application's Gemfile:
+It currently supports SVN and GIT, but plugins can easily be written for
+other systems.
 
-    gem 'between_meals'
+It also includes some wrappers around knife execution and a few other utility
+functions.
 
-And then execute:
+## Dependencies
 
-    $ bundle
+* Colorize
+* JSON
+* Mixlib::ShellOut
+* Rugged
 
-Or install it yourself as:
-
-    $ gem install between_meals
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/lib/between_meals/changes/change.rb

@@ -0,0 +1,46 @@
+# vim: syntax=ruby:expandtab:shiftwidth=2:softtabstop=2:tabstop=2
+# rubocop:disable ClassVars
+
+module BetweenMeals
+  # A set of classes that represent a given item's change (a cookbook
+  # that's changed, a role that's changed or a databag item that's changed).
+  #
+  # You almost certainly don't want to use this directly, and instead want
+  # BetweenMeals::Changeset
+  module Changes
+    # Common functionality
+    class Change
+      @@logger = nil
+      attr_accessor :name, :status
+      def to_s
+        @name
+      end
+
+      # People who use us through find() can just pass in logger,
+      # for everyone else, here's a setter
+      def logger=(log)
+        @@logger = log
+      end
+
+      def self.info(msg)
+        if @@logger
+          @@logger.info(msg)
+        end
+      end
+
+      def self.debug(msg)
+        if @@logger
+          @@logger.debug(msg)
+        end
+      end
+
+      def info(msg)
+        BetweenMeals::Changes::Change.info(msg)
+      end
+
+      def debug(msg)
+        BetweenMeals::Changes::Change.debug(msg)
+      end
+    end
+  end
+end

data/lib/between_meals/changes/cookbook.rb

@@ -0,0 +1,82 @@
+# vim: syntax=ruby:expandtab:shiftwidth=2:softtabstop=2:tabstop=2
+# rubocop:disable ClassVars
+
+module BetweenMeals
+  module Changes
+    # Changeset aware cookbook
+    class Cookbook < Change
+      def self.meaningful_cookbook_file?(path, cookbook_dirs)
+        cookbook_dirs.each do |dir|
+          re = %r{^#{dir}/([^/]+)/.*}
+          m = path.match(re)
+          debug("[cookbook] #{path} meaningful? [#{re}]: #{m}")
+          return true if m
+        end
+        false
+      end
+
+      def self.explode_path(path, cookbook_dirs)
+        cookbook_dirs.each do |dir|
+          re = %r{^#{dir}/([^/]+)/.*}
+          debug("[cookbook] Matching #{path} against ^#{re}")
+          m = path.match(re)
+          next unless m
+          info("Cookbook is #{m[1]}")
+          return {
+            :cookbook_dir => dir,
+            :name => m[1] }
+        end
+        nil
+      end
+
+      def initialize(files, cookbook_dirs)
+        @files = files
+        @name = self.class.explode_path(
+          files.sample[:path],
+          cookbook_dirs
+        )[:name]
+        # if metadata.rb is being deleted
+        #   cookbook is marked for deletion
+        # otherwise it was modified
+        #   and will be re-uploaded
+        if files.
+          select { |x| x[:status] == :deleted }.
+          map { |x| x[:path].match(%{.*metadata\.rb$}) }.
+          compact.
+          any?
+          @status = :deleted
+        else
+          @status = :modified
+        end
+      end
+
+      # Given a list of changed files
+      # create a list of Cookbook objects
+      def self.find(list, cookbook_dirs, logger)
+        @@logger = logger
+        return [] if list.nil? || list.empty?
+        # rubocop:disable MultilineBlockChain
+        list.
+          group_by do |x|
+          # Group by prefix of cookbok_dir + cookbook_name
+          # so that we treat deletes and modifications across
+          # two locations separately
+          g = self.explode_path(x[:path], cookbook_dirs)
+          g[:cookbook_dir] + '/' + g[:name] if g
+        end.
+        map do |_, change|
+          # Confirm we're dealing with a cookbook
+          # Changes to OWNERS or other stuff that might end up
+          # in [core, other, secure] dirs are ignored
+          is_cookbook = change.select do |c|
+            self.meaningful_cookbook_file?(c[:path], cookbook_dirs)
+          end.any?
+          if is_cookbook
+            BetweenMeals::Changes::Cookbook.new(change, cookbook_dirs)
+          end
+        end.compact
+        # rubocop:enable MultilineBlockChain
+      end
+    end
+  end
+end

data/lib/between_meals/changes/databag.rb

@@ -0,0 +1,36 @@
+# vim: syntax=ruby:expandtab:shiftwidth=2:softtabstop=2:tabstop=2
+# rubocop:disable ClassVars
+
+module BetweenMeals
+  module Changes
+    # Changeset aware databag
+    class Databag < Change
+      attr_accessor :item
+      def self.name_from_path(path, databag_dir)
+        re = %r{^#{databag_dir}/([^/]+)/([^/]+)\.json}
+        debug("[databag] Matching #{path} against #{re}")
+        m = path.match(re)
+        if m
+          info("Databag is #{m[1]} item is #{m[2]}")
+          return m[1], m[2]
+        end
+        nil
+      end
+
+      def initialize(file, databag_dir)
+        @status = file[:status]
+        @name, @item = self.class.name_from_path(file[:path], databag_dir)
+      end
+
+      def self.find(list, databag_dir, logger)
+        @@logger = logger
+        return [] if list.nil? || list.empty?
+        list.
+          select { |x| self.name_from_path(x[:path], databag_dir) }.
+          map do |x|
+            BetweenMeals::Changes::Databag.new(x, databag_dir)
+          end
+      end
+    end
+  end
+end

data/lib/between_meals/changes/role.rb

@@ -0,0 +1,37 @@
+# vim: syntax=ruby:expandtab:shiftwidth=2:softtabstop=2:tabstop=2
+# rubocop:disable ClassVars
+
+module BetweenMeals
+  module Changes
+    # Changeset aware role
+    class Role < Change
+      def self.name_from_path(path, role_dir)
+        re = "^#{role_dir}\/(.+)\.rb"
+        debug("[role] Matching #{path} against #{re}")
+        m = path.match(re)
+        if m
+          info("Name is #{m[1]}")
+          return m[1]
+        end
+        nil
+      end
+
+      def initialize(file, role_dir)
+        @status = file[:status] == :deleted ? :deleted : :modified
+        @name = self.class.name_from_path(file[:path], role_dir)
+      end
+
+      # Given a list of changed files
+      # create a list of Role objects
+      def self.find(list, role_dir, logger)
+        @@logger = logger
+        return [] if list.nil? || list.empty?
+        list.
+          select { |x| self.name_from_path(x[:path], role_dir) }.
+          map do |x|
+            BetweenMeals::Changes::Role.new(x, role_dir)
+          end
+      end
+    end
+  end
+end

data/lib/between_meals/changeset.rb

@@ -0,0 +1,48 @@
+# vim: syntax=ruby:expandtab:shiftwidth=2:softtabstop=2:tabstop=2
+require 'between_meals/changes/change'
+require 'between_meals/changes/cookbook'
+require 'between_meals/changes/role'
+require 'between_meals/changes/databag'
+
+module BetweenMeals
+  # Convenience for dealing with changes
+  # Represents a list of diffs between two revisions
+  # as a series of Cookbook and Role objects
+  #
+  # Basically, you always want to use BetweenMeals::Changes through this
+  # helper class.
+  class Changeset
+    class ReferenceError < Exception
+    end
+
+    def initialize(logger, repo, start_ref, end_ref, locations)
+      @logger = logger
+      @repo = repo
+      @cookbook_dirs = locations[:cookbook_dirs].dup
+      @role_dir = locations[:role_dir]
+      @databag_dir = locations[:databag_dir]
+      # Figure out which files changed if refs provided
+      # or return all files (full upload) otherwise
+      if start_ref
+        @files = []
+        @repo.changes(start_ref, end_ref).each do |file|
+          @files << file
+        end
+      else
+        @files = @repo.files
+      end
+    end
+
+    def cookbooks
+      BetweenMeals::Changes::Cookbook.find(@files, @cookbook_dirs, @logger)
+    end
+
+    def roles
+      BetweenMeals::Changes::Role.find(@files, @role_dir, @logger)
+    end
+
+    def databags
+      BetweenMeals::Changes::Databag.find(@files, @databag_dir, @logger)
+    end
+  end
+end