migrake 0.1.0 → 0.2.0

data/CHANGES

@@ -0,0 +1,12 @@
+0.2.0 - April 15, 2012
+----------------------
+
+- Refactored Store into FileSystemStore, make it swappable
+- Added FileSystemStore#prepare
+- Clean up the generated Rake tasks.
+- Change Migrake::Runner.run to Migrake.run.
+
+0.1.0 - April 15, 2012
+----------------------
+
+Initial release! :party:

data/README.md

@@ -45,26 +45,37 @@ check that file, see which tasks in the set aren't in it, and will run those
 tasks (no order is guaranteed, if you need tasks to run in order, define the
 dependencies in the task themselves.)
 
-## Overriding where to keep the MIGRAKE_STATUS file
+## Overriding the file where tasks are stored
 
 The file will be located, by default, at whichever directory `rake` is invoked
-from. In order to change that (for example, to put it in capistrano's `shared`
-directory), do either of the following:
+from. In order to change the path to the file, you can do this:
 
-Define `Migrake.status_file_directory` before running the tasks (so, for
-example, at the top of your `migrake.rake`):
+``` ruby
+Migrake.store = Migrake::FileSystemStore.new("./config/migrake")
+```
+
+This *must* be called in your Rakefile before you define the tasks to be run by
+`migrake`. Like this:
 
 ``` ruby
-Migrake.status_file_directory = File.expand_path("../tmp", __FILE__)
+require "migrake"
+
+Migrake.store = Migrake::FileSystemStore.new("./config/migrake")
+
+migrake Set.new([
+  # ...
+])
 ```
 
-Or as an alternative, pass it as an environment variable to Rake:
+As an alternative, you can make `MIGRAKE_STATUS_DIR` available to your
+environment, and migrake will use a `MIGRAKE_STATUS` file in that directory.
 
 ``` shell
 MIGRAKE_STATUS_DIR=./some/path bundle exec rake migrake
 ```
 
-The latter lets you define it within the capistrano definition file, like this:
+This is particularly useful to use with capistrano, since you probably want to
+use cap's `shared` directory to store your migrake file. For example:
 
 ``` ruby
 namespace :deploy do
@@ -76,6 +87,17 @@ end
 after "deploy:migrations", "deploy:migrake"
 ```
 
+## Heroku and other environments where you can't easily write to the filesystem
+
+The `FileSystemStore` is easily swappable. For the particular case of Heroku and
+similar servers we provide the [Migrake::SQLStore][sql-store] gem, that
+implements the storage API using a database table.
+
+Writing a new storage engine should be trivial. Use either `FileSystemStore` or
+`SQLStore` as an example.
+
+[sql-store]: http://github.com/foca/migrake-sql_store
+
 ## Bootstrapping a new environment
 
 When you bootstrap a new environment you don't need to run migrake tasks that

data/lib/migrake.rb

@@ -1,82 +1,30 @@
+require "set"
 require "rake/task"
 require "migrake/dsl"
 require "migrake/version"
-require "yaml"
-require "set"
-require "pathname"
 
 module Migrake
-  # Public: Change the directory where we keep the MIGRAKE_STATUS file.
-  #
-  # dir - A filesystem path.
-  #
-  # Returns the directory path.
-  def self.status_file_directory=(dir)
-    @status_dir = Pathname(dir)
+  class << self
+    # Public: Get/Set the store where Migrake checks for which tasks shouldn't
+    # be run. This should implement Migrake::FileSystemStore's interface.
+    attr_accessor :store
   end
 
-  # Public: Get the directory where we keep the MIGRAKE_STATUS file. If no
-  # directory is set, we will try to fetch it from the ENV, using the
-  # MIGRAKE_STATUS_DIR environment variable. If that isn't set either, we
-  # default to the working directory.
+  # Public: Run all the rake tasks in `set` that haven't been stored in
+  # `store`.
   #
-  # Returns a Pathname.
-  def self.status_file_directory
-    @status_dir ||= Pathname(ENV.fetch("MIGRAKE_STATUS_DIR", Dir.pwd))
-  end
-
-  # The Runner is responsible for selecting the rake tasks to be run and run
-  # them, unless they have already been run in this host.
-  module Runner
-    # Public: Run all the rake tasks in `set` that haven't been stored in
-    # `store`.
-    #
-    # set   - A Set with tasks to be run.
-    # store - A Migrake::Store with the tasks that have already been run.
-    #
-    # Returns the Set of tasks that were run.
-    def self.run(set, store)
-      (set - store.all).each do |task|
-        Rake::Task[task].invoke
-        store.put(task)
-      end
-    end
-  end
-
-  # The Store handles the file where tasks that have already been run are stored
-  # so they aren't run again.
-  class Store
-    # Public: Initialize the store.
-    #
-    # path - The path to the file where we store the information.
-    def initialize(path)
-      @path = path
-    end
-
-    # Public: Add one task to the store. This immediately writes the file to
-    # disk, to preserve consistency.
-    #
-    # task - A string with a task's name.
-    #
-    # Returns nil.
-    def put(task)
-      write(all << task)
-    end
-
-    # Public: Load all the tasks from the store.
-    #
-    # Returns a Set.
-    def all
-      @all ||= YAML.load(@path.read) || Set.new
-    end
-
-    # Public: Write a whole set of tasks to the store, replacing what is in it.
-    #
-    # set - A Set of tasks.
-    #
-    # Returns nil.
-    def write(set)
-      @path.open("w+") { |f| f.puts YAML.dump(set) }
+  # set   - A Set with tasks to be run.
+  # store - A Store (such as Migrake::FileSystemStore), to know which tasks
+  #         have already been run.
+  #
+  # Returns the Set of tasks that were run.
+  def self.run(set, store)
+    (set - store.all).each do |task|
+      Rake::Task[task].invoke
+      store.put(task)
     end
   end
 end
+
+# The FileSystemStore is the default store.
+require "migrake/file_system_store"

data/lib/migrake/dsl.rb

@@ -1,43 +1,32 @@
-require "migrake"
-
 module Migrake
   module DSL
     # Public: Define the rake tasks required to run migrake. This defines the
     # following tasks:
     #
-    #   - A task to create the `Migrake.status_file_directory` unless it exists.
-    #   - A task to create the MIGRAKE_STATUS file in the aforementioned
-    #     directory, unless it exists.
+    #   - A task to ensure we can use whatever is defined as `Migrake.store`.
     #   - A `migrake:ready` task to bootstrap new environments by writing all
     #     the tasks to the store.
     #   - The `migrake` task, that will run any tasks not run before.
     #
     # tasks - A Set of tasks to be run.
     #
-    # Returns the `migrake` Rake::Task.
+    # Returns nothing.
     def migrake(tasks)
-      dir = Migrake.status_file_directory
-      status_file = dir.join("MIGRAKE_STATUS")
-
       namespace :migrake do
-        directory dir.to_s
-
-        file status_file.to_s => dir.to_s do
-          touch status_file
-        end
-
-        task :run_tasks => status_file.to_s do
-          Migrake::Runner.run(tasks, Migrake::Store.new(status_file))
+        task :check_store do
+          Migrake.store.prepare
         end
 
         desc "Tell migrake that all defined tasks have already been run"
-        task :ready => status_file.to_s do
-          Migrake::Store.new(status_file).write(tasks)
+        task ready: :check_store do
+          Migrake.store.write(tasks)
         end
       end
 
       desc "Run the tasks defined by migrake"
-      task migrake: "migrake:run_tasks"
+      task migrake: "migrake:check_store" do
+        Migrake.run(tasks, Migrake.store)
+      end
     end
   end
 end

data/lib/migrake/file_system_store.rb

@@ -0,0 +1,55 @@
+require "yaml"
+require "pathname"
+require "fileutils"
+
+# The FileSystemStore handles the file where tasks that have already been run
+# are stored so they aren't run again.
+class Migrake::FileSystemStore
+  # Public: Initialize the store.
+  #
+  # path - The path to the file where we store the information. A Pathname of
+  #        String should be provided.
+  def initialize(path)
+    @path = Pathname(path)
+  end
+
+  # Public: Ensure the file we use to store information exists.
+  #
+  # Returns nothing.
+  def prepare
+    FileUtils.mkdir_p @path.dirname
+    FileUtils.touch @path
+  end
+
+  # Public: Add one task to the store. This immediately writes the file to
+  # disk, to preserve consistency.
+  #
+  # task - A string with a task's name.
+  #
+  # Returns nothing.
+  def put(task)
+    write(all << task)
+  end
+
+  # Public: Load all the tasks from the store.
+  #
+  # Returns a Set.
+  def all
+    @all ||= YAML.load(@path.read) || Set.new
+  end
+
+  # Public: Write a whole set of tasks to the store, replacing what is in it.
+  #
+  # set - A Set of tasks.
+  #
+  # Returns nothing.
+  def write(set)
+    @path.open("w+") { |f| f.puts YAML.dump(set) }
+  end
+end
+
+# Automagic configuration. If this environment has a MIGRAKE_STATUS_DIR, use it
+# for the MIGRAKE_STATUS file. If not, default to the current directory.
+Migrake.store = Migrake::FileSystemStore.new(
+  Pathname(ENV.fetch("MIGRAKE_STATUS_DIR", Dir.pwd)).join("MIGRAKE_STATUS")
+)

data/lib/migrake/version.rb

@@ -1,3 +1,3 @@
 module Migrake
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/{store_test.rb → file_system_store_test.rb}

@@ -1,22 +1,22 @@
 require_relative "test_helper"
 require "tempfile"
 
-describe Migrake::Store do
+describe Migrake::FileSystemStore do
   it "can read a stored set" do
     set = Set.new(["a", "b", "c"])
     save_in_source set
 
-    store = Migrake::Store.new(source)
+    store = Migrake::FileSystemStore.new(source)
     assert_equal set, store.all
   end
 
   it "an empty file means an empty set" do
-    store = Migrake::Store.new(source)
+    store = Migrake::FileSystemStore.new(source)
     assert_equal Set.new, store.all
   end
 
   it "can add an entry to the store" do
-    store = Migrake::Store.new(source)
+    store = Migrake::FileSystemStore.new(source)
     store.put("test")
 
     assert_equal Set.new(["test"]), store.all
@@ -25,7 +25,7 @@ describe Migrake::Store do
   it "can write a set replacing whatever is there on the file" do
     save_in_source Set.new(["d", "e", "f", "g"])
 
-    store = Migrake::Store.new(source)
+    store = Migrake::FileSystemStore.new(source)
     store.write Set.new(["a", "b", "c"])
 
     assert_equal Set.new(["a", "b", "c"]), store.all

data/test/{runner_test.rb → migrake_test.rb}

@@ -1,14 +1,14 @@
 require_relative "test_helper"
 require "rake"
 
-describe Migrake::Runner do
+describe Migrake do
   it "runs tasks that aren't in the store" do
     define_tasks "a", "b", "c"
     define_store "a"
 
     expect_tasks_ran "b", "c"
 
-    Migrake::Runner.run(Set.new(["a", "b", "c"]), store)
+    Migrake.run(Set.new(["a", "b", "c"]), store)
 
     store.verify
   end
@@ -18,7 +18,7 @@ describe Migrake::Runner do
     define_store "a", "b", "c"
     # setting no expectation for tasks run passes only if no tasks are run
 
-    Migrake::Runner.run(Set.new(["a", "b", "c"]), store)
+    Migrake.run(Set.new(["a", "b", "c"]), store)
 
     store.verify
   end
@@ -29,7 +29,7 @@ describe Migrake::Runner do
 
     expect_tasks_ran "a"
 
-    Migrake::Runner.run(Set.new(["a", "b", "c"]), store)
+    Migrake.run(Set.new(["a", "b", "c"]), store)
 
     store.verify
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: migrake
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70142092483920 !ruby/object:Gem::Requirement
+  requirement: &70224747638560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *70142092483920
+  version_requirements: *70224747638560
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70142092483500 !ruby/object:Gem::Requirement
+  requirement: &70224747638100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70142092483500
+  version_requirements: *70224747638100
 description: Migrake allows you to run rake tasks that only need to be run once in
   a given environment each time you deploy
 email: hi@nicolassanguinetti.info
@@ -42,16 +42,18 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGES
 - Gemfile
 - README.md
 - Rakefile
 - examples/Rakefile
 - lib/migrake.rb
 - lib/migrake/dsl.rb
+- lib/migrake/file_system_store.rb
 - lib/migrake/version.rb
 - migrake.gemspec
-- test/runner_test.rb
-- test/store_test.rb
+- test/file_system_store_test.rb
+- test/migrake_test.rb
 - test/test_helper.rb
 homepage: http://github.com/foca/migrake
 licenses: []