kit 0.3.0 → 1.0.0

data/lib/kit/db_support.rb

@@ -0,0 +1,71 @@
+module KitDBSupport
+
+  # Create a database.
+  # @raise RuntimeError This will raise an exception if databse exists.
+  # @param [Hash] config ActiveRecord::Base database configuration
+  def self.create! config
+    case config[:adapter]
+    when 'sqlite3'
+      db_file = config[:database]
+      raise RuntimeError, "Database file #{db_file} exists." if File.exists? db_file
+      SQLite3::Database.new config[:database]
+    else
+      raise RuntimeError, "Creating database with adapter #{config[:adapter]} not supported."
+    end
+  end
+
+  # (see #create!)
+  def self.create *args
+    begin
+      create! *args
+    rescue RuntimeError, /^Database file .+ exists.$/
+    end
+  end
+
+  # Destory a database.
+  # @raise RuntimeError This will raise an exception if databse does not exist.
+  # @param (see create!)
+  def self.destroy! config
+    case config[:adapter]
+    when 'sqlite3'
+      db_file = config[:database]
+      raise RuntimeError, "Database file #{db_file} does not exist." unless File.exists? db_file
+      File.unlink db_file
+    else
+      raise RuntimeError, "Destroying database with adapter #{config[:adapter]} not supported."
+    end
+  end
+
+  # (see #destroy)
+  def self.destroy *args
+    begin
+      destroy! *args
+    rescue RuntimeError, /^Database file .+ does not exist.$/
+    end
+  end
+
+  # Establishes an ActiveRecord::Base connection.
+  # @param [Hash] config settings for ActiveRecord::Base
+  def self.connect config
+    ActiveRecord::Base.establish_connection config
+  end
+
+  # Migrate up or down a given number of migrations.
+  # @param [String] path location of migration files
+  # @param [Symbol] direction
+  # @param [Integer] steps
+  def self.migrate path, direction = nil, steps = 1
+    if direction.nil?
+      ActiveRecord::Migrator.migrate(path, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+    else
+      ActiveRecord::Migrator.send direction, path, steps
+    end
+  end
+
+  # Migrate to a specfic migration.
+  # @param path (see #migrate)
+  # @param [Integer] version the migration number
+  def self.migrate_to path, version
+    ActiveRecord::Migrator.migrate(path, version)
+  end
+end

data/lib/kit/models/bit.rb

@@ -0,0 +1,34 @@
+class Kit::Bit < ActiveRecord::Base
+
+  belongs_to :group
+  has_many :permissions
+  has_many :users, :through => :permissions
+
+  after_initialize do
+    if self.group.nil?
+      self.extend KitActionsDefault
+    else
+      mod = "KitActions#{self.group.name.gsub(' ', '_').camelize}"
+      self.extend Kernel.const_get(mod) if Kernel.const_defined? mod
+    end
+  end
+
+  class Job
+
+    def initialize *args
+      if args[0].is_a? Hash
+        hash = args[0]
+        args = [ hash[:config_file], hash[:bit_id], hash[:action], *hash[:args] ]
+      end
+      @config_file = args[0]
+      @bit_id      = args[1]
+      @action      = args[2]
+      @args        = *args[3..-1]
+    end
+
+    def perform
+      Kit.open @config_file
+      Kit::Bit.find(@bit_id).send(@action, *@args)
+    end
+  end
+end

data/lib/kit/models/group.rb

@@ -0,0 +1,5 @@
+class Kit::Group < ActiveRecord::Base
+
+  has_many :bits
+
+end

data/lib/kit/models/permission.rb

@@ -0,0 +1,6 @@
+class Kit::Permission < ActiveRecord::Base
+
+  belongs_to :user
+  belongs_to :bit
+
+end

data/lib/kit/models/user.rb

@@ -0,0 +1,6 @@
+class Kit::User < ActiveRecord::Base
+
+  has_many :permissions
+  has_many :bits, :through => :permissions
+
+end

data/lib/kit/rake/admin.rb

@@ -0,0 +1,3 @@
+require 'kit/rake/admin/database'
+require 'kit/rake/admin/manage'
+require 'kit/rake/admin/make'

data/lib/kit/rake/admin/database.rb

@@ -0,0 +1,28 @@
+namespace 'db' do
+
+  kit = Kit.new 'config.yml'
+
+  task :create do
+    kit.db_create
+  end
+
+  task :destroy do
+    kit.db_destroy
+  end
+
+  task :reset => [:destroy, :create, :migrate] do
+  end
+
+  task :environment do
+    kit.db_connect
+  end
+
+  task :migrate, [:direction, :steps]  => [:create, :environment] do |_, args|
+    args.with_defaults(direction: nil, steps: 1)
+    if args[:direction].nil?
+      kit.db_migrate
+    else
+      kit.db_migrate args[:direction], args[:steps]
+    end
+  end
+end

data/lib/kit/rake/admin/make.rb

@@ -0,0 +1,19 @@
+namespace 'mk' do
+
+  def make_class_template file_name, class_line
+    unless File.exists? file_name
+      f = File.new file_name, 'w+'
+      f << class_line
+      f << "\nend"
+      f.close
+    end
+  end
+
+  task :migration, :name do |_, args|
+    make_class_template "migrations/#{Time.now.utc.strftime('%Y%m%d%H%M%S')}_#{args[:name]}.rb", "class #{args[:name].camelize} < ActiveRecord::Migration"
+  end
+
+  task :model, :name do |_, args|
+    make_class_template "models/#{args[:name]}.rb", "class Kit::#{args[:name].camelize} < ActiveRecord::Base"
+  end
+end

data/lib/kit/rake/admin/manage.rb

@@ -0,0 +1,8 @@
+namespace 'add' do
+
+  task :group, :name do |_, args|
+    kit = Kit.open 'config.yml'
+    Kit::Group.create :name => args[:name].gsub('_', ' ')
+    make_class_template "actions/#{args[:name]}.rb", "module KitActions#{args[:name].camelize}"
+  end
+end

data/lib/kit/version.rb

@@ -0,0 +1,4 @@
+class Kit
+  # Version number.
+  VERSION = '1.0.0'
+end

data/spec/bit_spec.rb

@@ -0,0 +1,57 @@
+require 'kit'
+
+describe Kit::Bit do
+
+  before :all do
+    @config_file = File.expand_path '../../test_kit/config.yml', __FILE__
+    Kit.new(@config_file).db_create.db_connect.db_migrate
+  end
+
+  after :all do
+    Kit.new(@config_file).db_destroy
+  end
+
+  before :each do
+    Kit.open @config_file
+  end
+
+  describe Kit::Bit::Job do
+
+    [:args, :hash].each do |type|
+
+      describe ".perform" do
+
+        context "given #{type}" do
+
+          config = File.expand_path '../../test_kit/config.yml', __FILE__
+          if type == :args
+            subject { Kit::Bit::Job.new config, 1, :the_action, :arg_1, :arg_2 }
+          else
+            hash = { config_file: config, bit_id: 1, action: :the_action, args: [:arg_1, :arg_2] }
+            subject { Kit::Bit::Job.new hash }
+          end
+
+          before :each do
+            @bit = mock('Kit::Bit', :id => 1, :the_action => nil)
+            Kit::Bit.stub(:find).and_return(@bit)
+          end
+
+          it "opens the kit" do
+            Kit.should_receive(:open).with(@config_file)
+            subject.perform
+          end
+
+          it "looks for the bit" do
+            Kit::Bit.should_receive(:find).with(1)
+            subject.perform
+          end
+
+          it "runs the action on the bit" do
+            @bit.should_receive(:the_action).with(:arg_1, :arg_2)
+            subject.perform
+          end
+        end
+      end
+    end
+  end
+end

data/spec/kit_db_support_spec.rb

@@ -0,0 +1,110 @@
+require 'kit'
+
+describe KitDBSupport do
+
+  before :all do
+    @config = {}
+    @config[:sqlite3] = { adapter: 'sqlite3', database: 'spec_db.sqlite3' }
+    @sqlite3 = @config[:sqlite3]
+  end
+
+  describe "create!" do
+
+    it "raises error if adapter not supported" do
+      expect { KitDBSupport::create!(:adapter => 'bad_adapter') }.should raise_error RuntimeError, /not supported/
+    end
+
+    context "adapter is sqlite3" do
+
+      it "creates the sqlite3 database file" do
+        File.stub(:exists?).with(@sqlite3[:database]).and_return(false)
+        SQLite3::Database.should_receive(:new).with(@sqlite3[:database])
+        KitDBSupport::create! @config[:sqlite3]
+      end
+
+      it "raises error if sqlite3 database file exists" do
+        File.stub(:exists?).with(@sqlite3[:database]).and_return(true)
+        expect { KitDBSupport::create! @config[:sqlite3] }.should raise_error RuntimeError, /exists/
+      end
+    end
+  end
+
+  describe "create" do
+    it "calls create!" do
+      KitDBSupport.should_receive(:create!)
+      KitDBSupport::create
+    end
+
+    it "does not raise error if sqlite3 database file exists" do
+      File.stub(:exists?).with(@sqlite3[:database]).and_return(true)
+      expect { KitDBSupport::create @config[:sqlite3] }.should_not raise_error RuntimeError, /exists/
+    end
+  end
+
+  describe "destroy!" do
+
+    it "raises error if adapter not supported" do
+      expect { KitDBSupport::destroy!(:adapter => 'bad_adapter') }.should raise_error RuntimeError, /not supported/
+    end
+
+    context "adapter is sqlite3" do
+
+      it "unlinks the sqlite3 databasefile " do
+        File.stub(:exists?).with(@sqlite3[:database]).and_return(true)
+        File.should_receive(:unlink).with( @sqlite3[:database] )
+        KitDBSupport::destroy! @config[:sqlite3]
+      end
+
+      it "raises error if sqlite3 database file does not exist" do
+        File.stub(:exists?).with(@sqlite3[:database]).and_return(false)
+        expect { KitDBSupport::destroy! @config[:sqlite3] }.should raise_error RuntimeError, /does not exist/
+      end
+    end
+  end
+
+  describe "destroy" do
+    it "calls destroy!" do
+      KitDBSupport.should_receive(:destroy!)
+      KitDBSupport::destroy
+    end
+
+    it "does not raise error if sqlite3 database file does not exist" do
+      File.stub(:exists?).with(@sqlite3[:database]).and_return(false)
+      expect { KitDBSupport::destroy @config[:sqlite3] }.should_not raise_error RuntimeError, /does not exist/
+    end
+  end
+
+  describe "connect" do
+
+    it "makes active record establish a connection" do
+      ActiveRecord::Base.should_receive(:establish_connection).with(@config[:sqlite3])
+      KitDBSupport::connect @config[:sqlite3]
+    end
+  end
+
+  describe "migrate" do
+
+    it "migrates to latest version when called with no arguments" do
+      ActiveRecord::Migrator.should_receive(:migrate)
+      KitDBSupport::migrate 'migrations'
+    end
+
+    it "migrates one step in a given direction" do
+      ActiveRecord::Migrator.should_receive(:up).with('migrations', 1)
+      KitDBSupport::migrate 'migrations', :up
+    end
+
+    it "migrates many steps in a given direction" do
+      ActiveRecord::Migrator.should_receive(:up).with('migrations', 3)
+      KitDBSupport::migrate 'migrations', :up, 3
+    end
+  end
+
+  describe "migrate_to" do
+
+    it "migrates to a specific migration" do
+      ActiveRecord::Migrator.should_receive(:migrate).with('migrations', 001)
+      KitDBSupport::migrate_to 'migrations', 001
+    end
+  end
+end

data/spec/kit_spec.rb

@@ -0,0 +1,56 @@
+require 'kit'
+
+describe Kit do
+
+  before :all do
+    @kit_path = File.expand_path '../../test_kit', __FILE__
+    @config_file = File.expand_path '../../test_kit/config.yml', __FILE__
+    @config = YAML.load File.read("#{@kit_path}/config.yml")
+  end
+
+  subject { Kit.new @config_file }
+
+  describe ".path" do
+
+    it "determines the correct path to the kit" do
+      subject.path.should == @kit_path
+    end
+  end
+
+  describe ".config" do
+
+    it "loads the config file" do
+      subject.config.should == @config
+    end
+  end
+
+  describe ".open" do
+
+    it "creates a new kit and opens a database connections" do
+      Kit.any_instance.should_receive(:db_connect)
+      Kit.open @config_file
+    end
+  end
+
+  db_actions              = {}
+  db_actions[:destroy]    = [Hash.new]
+  db_actions[:create]     = [Hash.new]
+  db_actions[:migrate]    = [String.new, Hash.new, 0]
+  db_actions[:migrate_to] = [String.new, 0]
+
+  db_actions.each do |action, args|
+
+    describe ".db_#{action}" do
+
+      it "calls KitDBSupport::#{action}" do
+        KitDBSupport.should_receive(action).with( *( args.map { |x| kind_of(x.class) } ) )
+        subject.send "db_#{action}", *args[1..-1]
+      end
+
+      it "returns the instance of Kit" do
+        KitDBSupport.stub action
+        subject.send("db_#{action}", *args[1..-1]).should equal subject
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,32 +9,119 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-25 00:00:00.000000000 Z
+date: 2012-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: &75741220 !ruby/object:Gem::Requirement
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *75741220
-description: ! "\t\tKit is a framework for making simple management tools called kits.\n"
-email: 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extendable tool to manage site development and more.
+email:
+- razorx@evansosenko.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/kit/db_sqlite3.rb
-- lib/kit/bit.rb
-- lib/kit.rb
+- .gitignore
+- .rspec
+- .yardopts
 - CHANGELOG.rdoc
+- Gemfile
+- LICENSE.txt
 - README.rdoc
-- LICENCE.txt
-homepage: 
+- Rakefile
+- kit.gemspec
+- lib/kit.rb
+- lib/kit/db_support.rb
+- lib/kit/models/bit.rb
+- lib/kit/models/group.rb
+- lib/kit/models/permission.rb
+- lib/kit/models/user.rb
+- lib/kit/rake/admin.rb
+- lib/kit/rake/admin/database.rb
+- lib/kit/rake/admin/make.rb
+- lib/kit/rake/admin/manage.rb
+- lib/kit/version.rb
+- spec/bit_spec.rb
+- spec/kit_db_support_spec.rb
+- spec/kit_spec.rb
+homepage: http://evansosenko.com
 licenses:
 - MIT
 post_install_message: 
@@ -46,19 +133,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-requirements:
-- SQLite3
+requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Extendable tool to manage site development and more.
-test_files: []
+summary: Kit is a framework for making simple management tools called kits.
+test_files:
+- spec/bit_spec.rb
+- spec/kit_db_support_spec.rb
+- spec/kit_spec.rb
 has_rdoc: