shaf 0.3.1 → 0.4.0

data/lib/shaf/{api_doc/task.rb → tasks/api_doc_task.rb}

@@ -1,8 +1,9 @@
 require 'shaf/api_doc/document'
+require 'shaf/api_doc/comment'
 
 module Shaf
-  module ApiDoc
-    class Task
+  module Tasks
+    class ApiDocTask
       include Rake::DSL
 
       attr_accessor :document_class, :source_dir, :html_output_dir, :yaml_output_dir
@@ -10,7 +11,7 @@ module Shaf
       def initialize
         yield self if block_given?
         validate_attributes!
-        @document_class ||= Document
+        @document_class ||= ApiDoc::Document
         define_tasks
       end
 
@@ -48,7 +49,7 @@ module Shaf
 
       def read_file(file)
         doc = document_class.new
-        comment = Comment.new
+        comment = ApiDoc::Comment.new
 
         File.readlines(file).each do |line|
           next if empty_line?(line)
@@ -59,7 +60,7 @@ module Shaf
           end
 
           parse_line(line, doc, comment)
-          comment = Comment.new
+          comment = ApiDoc::Comment.new
         end
 
         return doc unless block_given?

data/lib/shaf/tasks/db_task.rb

@@ -0,0 +1,42 @@
+module Shaf
+  module Tasks
+    class DbTask
+      include Rake::DSL
+
+      def initialize(name, description:, args: [], &block)
+        @name = name
+        @desc = description
+        @args = args
+        @block = block
+        define_task
+      end
+
+      def define_task
+        namespace :db do
+          desc @desc
+          task @name, @args do |t, args|
+            require 'config/database'
+            Sequel.extension :migration
+            instance_exec(t, args, &@block)
+          end
+        end
+      end
+
+      def migrations
+        @migrations ||= DB[:schema_migrations].all
+      end
+
+      def last_migration
+        DB[:schema_migrations].order(:filename).last
+      end
+
+      def extract_version_and_filename(filename)
+        return [] unless filename
+        filename = filename[:filename] if filename.is_a? Hash
+        match = /(\d*)_(.*).rb/.match(filename)
+        return [] unless match
+        match[1..2]
+      end
+    end
+  end
+end

data/lib/shaf/tasks/test_task.rb

@@ -0,0 +1,16 @@
+require 'rake/testtask'
+
+module Shaf
+  module Tasks
+    class TestTask < Rake::TestTask
+      def initialize(*args)
+        super(*args) do |t|
+          t.libs = %w(. api spec)
+          t.verbose = true
+          t.warning = false
+          yield self if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/shaf/upgrade.rb

@@ -0,0 +1,3 @@
+require 'shaf/upgrade/version'
+require 'shaf/upgrade/manifest'
+require 'shaf/upgrade/package'

data/lib/shaf/upgrade/manifest.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+module Shaf
+  module Upgrade
+    class Manifest
+      attr_reader :target_version, :patches
+
+      def initialize(target_version:, patches: {})
+        @target_version = target_version
+        @patches = build_patterns(patches)
+      end
+
+      def build_patterns(patches)
+        patches.each_with_object({}) do |(chksum, pattern), hash|
+          hash[chksum] = /#{pattern}/
+        end
+      end
+
+      def patch_name_for(file)
+        @patches.select { |_, pattern| pattern =~ file }.keys.first
+      end
+    end
+  end
+end
+
+# Example of manifest:
+# ---
+# target_version: 0.4.0
+# patches:
+#   cd5b0bf61070a9fd57e60c45e9aaf64a: config/database.rb
+#   59783ecfa5f41b84c6fad734e7aa6a1d: Rakefile

data/lib/shaf/upgrade/package.rb

@@ -0,0 +1,158 @@
+require 'rubygems/package'
+require 'zlib'
+require 'set'
+require 'digest'
+require 'open3'
+
+module Shaf
+  module Upgrade
+    class Package
+      include Comparable
+
+      class UpgradeError < StandardError; end
+      class VersionNotFoundError < UpgradeError; end
+      class VersionConflictError < UpgradeError; end
+      class ManifestNotFoundError < UpgradeError; end
+      class MissingPatchError < UpgradeError; end
+      class PatchNotInManifestError < UpgradeError; end
+      class BadChecksumError < UpgradeError; end
+
+      UPGRADE_FILES_PATH = File.join(Utils.gem_root, 'upgrades').freeze
+      MANIFEST_FILENAME = 'manifest'.freeze
+
+      attr_reader :version
+
+      class << self
+        def all
+          target_versions.map(&method(:new))
+        end
+
+        def load(version)
+          v = strip_suffix(version)
+          raise VersionNotFoundError unless target_versions.include? v
+          new(v).tap(&:load)
+        end
+
+        private
+
+        def target_versions
+          return @target_versions if @target_versions
+
+          files = Dir[File.join(UPGRADE_FILES_PATH, '*.tar.gz')]
+          @target_versions = files.each_with_object([]) do |file, versions|
+            str = File.basename(file, '.tar.gz')
+            versions << Version.new(str)
+          end
+        end
+
+        def strip_suffix(file)
+          file.sub('.tar.gz', '')
+        end
+      end
+
+      def initialize(version)
+        @version = Version.new(version)
+        @manifest = nil
+        @patches = {}
+      end
+
+      def load
+        File.open(tarball, 'rb') do |file|
+          Zlib::GzipReader.wrap(file) do |gz|
+            Gem::Package::TarReader.new(gz) do |tar|
+              tar.each(&method(:add_tar_entry))
+            end
+          end
+        end
+        validate
+        self
+      end
+
+      def <=>(other)
+        version = other.is_a?(String) ? other : other.version
+        @version <=> version
+      end
+
+      def apply(dir = nil)
+        files_in(dir).all? do |file|
+          name = @manifest.patch_name_for(file) # returns nil when file
+          next true unless name                 # shouldn't be patched
+          patch = @patches[name]
+          apply_patch(file, patch)
+        end
+      end
+
+      def to_s
+        if @manifest.nil?
+          "Shaf::Upgrade::Package for version #{@version}"
+        else
+          count = @patches.size
+          count_str = "#{count} patch#{count == 1 ? "" : "es"}" 
+          "Shaf::Upgrade::Package for version #{@version}, containing #{count_str}"
+        end
+      end
+
+      private
+
+      def tarball
+        file = File.join(UPGRADE_FILES_PATH, "#{@version}.tar.gz")
+        return file if File.exist? file
+        raise VersionNotFoundError
+      end
+
+      def add_tar_entry(entry)
+        filename = entry.full_name
+        content = entry.read
+
+        if filename == MANIFEST_FILENAME
+          parse_manifest content
+        else
+          @patches[filename] = content
+        end
+      end
+
+      def parse_manifest(content)
+        h = YAML.safe_load(content)
+        @manifest = Manifest.new(
+          target_version: h['target_version'],
+          patches: h['patches']
+        )
+      end
+
+      def validate
+        raise ManifestNotFoundError unless @manifest
+        raise VersionConflictError unless @version == @manifest.target_version
+
+        from_manifest = @manifest.patches.keys.to_set
+        from_file = @patches.keys.to_set
+        raise MissingPatchError if from_file < from_manifest
+        raise PatchNotInManifestError if from_manifest < from_file
+
+        @patches.each do |md5, content|
+          raise BadChecksumError unless Digest::MD5.hexdigest(content) == md5
+        end
+
+        true
+      end
+
+      def files_in(dir)
+        dir += '/' if !dir.nil? && dir[-1] != '/'
+        Dir["#{dir}**/*"]
+      end
+
+      def apply_patch(file, patch)
+        success = nil
+        Open3.popen3('patch', file, '-r', '-') do |i, o, e, t|
+          i.write patch
+          i.close
+          puts o.read
+          err = e.read
+          puts err unless err.empty?
+          success = t.value.success?
+        end
+        success
+      end
+
+    end
+  end
+end

data/lib/shaf/upgrade/version.rb

@@ -0,0 +1,52 @@
+module Shaf
+  module Upgrade
+    class Version
+      include Comparable
+
+      attr_reader :major, :minor, :patch
+
+      alias eql? ==
+
+      class UpgradeVersionError < StandardError
+        def initialize(message = "")
+          super("Bad upgrade version: #{message}")
+        end
+      end
+
+      def initialize(version)
+        if self.class === version
+          @major, @minor, @patch = [:major, :minor, :patch].map { |m| version.send m }
+        else
+          raise UpgradeVersionError.new(version) unless version =~ /\d+\.\d+\.\d+/
+          @major, @minor, @patch = split_version(version)
+        end
+      end
+
+      def <=>(other)
+        if other.is_a? String
+          compare_version(*split_version(other))
+        else
+          compare_version(other.major, other.minor, other.patch)
+        end
+      end
+
+      def to_s
+        [major, minor, patch].join('.')
+      end
+
+      private
+
+      def split_version(str)
+        str.split('.').map(&:to_i)
+      end
+
+      def compare_version(other_major, other_minor, other_patch)
+        [
+          major <=> other_major,
+          minor <=> other_minor,
+          patch <=> other_patch
+        ].find { |x| !x.zero? } || 0
+      end
+    end
+  end
+end

data/lib/shaf/utils.rb

@@ -2,6 +2,8 @@ module Shaf
   module Utils
     class ProjectRootNotFound < StandardError; end
 
+    SHAF_VERSION_FILE = '.shaf'.freeze
+
     # FIXME!!!
     def self.pluralize(noun)
       noun + 's' # FIXME!!
@@ -11,6 +13,10 @@ module Shaf
       name.capitalize.gsub(/[_-](\w)/) { $1.upcase }
     end
 
+    def self.gem_root
+      File.expand_path('../../..', __FILE__)
+    end
+
     # FIXME!!!
     def self.singularize(noun)
       return singularize(noun.to_s).to_sym if noun.is_a? Symbol
@@ -18,6 +24,10 @@ module Shaf
       noun[0..-2]
     end
 
+    def gem_root
+      self.class.gem_root
+    end
+
     def project_root
       dir = Dir.pwd
       20.times do
@@ -61,5 +71,25 @@ module Shaf
     def pluralize(noun)
       Utils::pluralize(noun)
     end
+
+    def read_shaf_file
+      return {} unless File.exist? SHAF_VERSION_FILE
+      str = File.read(SHAF_VERSION_FILE)
+      YAML.load(str) || {}
+    end
+
+    def write_shaf_file(data = {})
+      data = read_shaf_file.merge(data)
+      File.write SHAF_VERSION_FILE,
+        YAML.dump(data)
+    end
+
+    def read_shaf_version
+      read_shaf_file['version']
+    end
+
+    def write_shaf_version(version = nil)
+      write_shaf_file('version' => version || Shaf::VERSION)
+    end
   end
 end

data/lib/shaf/version.rb

@@ -1,3 +1,3 @@
 module Shaf
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/templates/Rakefile

@@ -2,11 +2,10 @@ require 'rubygems'
 require 'bundler'
 Bundler.setup(:default, :development)
 $:.unshift __dir__
-require 'shaf/tasks'
+require 'shaf/rake'
 require 'shaf/settings'
-require 'shaf/api_doc'
 
-Shaf::ApiDoc::Task.new do |api_doc|
+Shaf::ApiDocTask.new do |api_doc|
   api_doc.source_dir = File.join(%w(api serializers))
   api_doc.html_output_dir = File.join(Shaf::Settings.public_folder, "doc")
   api_doc.yaml_output_dir = Shaf::Settings.documents_dir || "doc/api"

data/templates/config/database.rb

@@ -3,7 +3,7 @@ require 'sequel'
 require 'config/constants'
 require 'fileutils'
 
-CONFIG = {
+config = {
 
   production: {
     adapter: 'postgres',
@@ -28,7 +28,7 @@ CONFIG = {
 
 env = Sinatra::Application.settings.environment
 
-unless CONFIG[env]
+unless config[env]
   STDERR.puts "No Database config for environment '#{env}'"
   exit 1
 end
@@ -36,5 +36,5 @@ end
 MIGRATIONS_DIR = File.join(APP_ROOT, Shaf::Settings.migrations_dir)
 FileUtils.mkdir_p(MIGRATIONS_DIR) unless Dir.exist?(MIGRATIONS_DIR)
 
-DB = Sequel.connect(CONFIG[env])
+DB = Sequel.connect(config[env])