totem 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1642673b0d6a2651e9c4d5b6b92042d1ff2762da
-  data.tar.gz: 005d524961253413c80a226d6cd7fbb19372886f
+  metadata.gz: a738bec72280ea0baf97f9860a2238ea0579f84a
+  data.tar.gz: 80ce4e412fed17d5184416406bc72d97165b067f
 SHA512:
-  metadata.gz: 153b35b769aeafb208e237efb13efb6d5b1fed0692a168da4a77f607715c137fa27f28180fb206669f64d857e2d5e52a92b731e994394a4ce6bee1f6041a5b33
-  data.tar.gz: ceac5fb168525595f9062d3a37f7c12100184c0b03fb25fbe3293796639e4bfb1b9349e8a04878964f65a40db82673652e3f916ec67a92b7bc312a2bf9071cf8
+  metadata.gz: 7a38f51673de6d90b89411cb151296f6a586caba29c8bac1e107d76b01cd4c1fa585828fed5ac929c5a3d8ee42abb43712059a5d608a49a89c49e9fd31d97503
+  data.tar.gz: 666ca16224d5a57a6e62c85ba1b82a07fbf2acdc43c189eb110f65944654f81ae6b517b85466cc051e6f9987233902cf1a4aa45fece8b0eb24d0971b1bd9a605

data/README.md

@@ -1,16 +1,20 @@
 # Totem
 
-Totem is a framework for creating Ruby projects.
+Totem is a Ruby gem for creating Ruby projects.
 It's like having a Rails project folder without the Rails dependency.
 
-Features:
-- Ruby on Rails inspired folder structure.
-- Lightweight and simple code.
-- Integrated console.
-- Uses built in Ruby classes and avoids depending on 3rd party gems.
-- Designed for MRI and JRuby.
-- Easily extensible through gems or directly in your project (ActiveRecord gem coming soon).
-- Designed for multi-threaded applications.
+##### Goals:
+- Use a Ruby on Rails inspired folder structure because many developers are familiar with it.
+- Keep the gem lightweight with simple and easy to understand code.
+- Prefer built in Ruby classes in order to avoid third party dependencies.
+- Design from day one for MRI and JRuby.
+- Make it easily extensible.
+- Maintain thread safety so that it can be used with gems such as [Tribe](https://github.com/chadrem/tribe) or [Celluloid](https://github.com/celluloid/celluloid).
+
+##### Features:
+- console
+- logger
+- environments (development, production, stage, etc).
 
 ## Installation
 
@@ -26,22 +30,51 @@ Or install it yourself as:
 
     $ gem install totem
 
-## Usage
+## Create a project
 
-Create a new project called "my_app" in the current directory:
+Create a new project called `my_app` in the current directory:
 
-    $ totem new my_app
+    $ bundle exec totem new my_app
 
-You must now setup Bundler (and rvm, rbenv, etc) for your new project:
+You must now setup Bundler (and rvm, rbenv, etc if you use them) for your new project:
 
     $ bundle
 
-You can now create your custom classes in the "app" directory.
-You will need to manually "require" your classes in "app/loader.rb" since there isn't an auto-loader.
+You can now create your custom classes in the `app` directory.
+You will need to manually `require` your classes in `app/loader.rb` since Tribe doesn't have an auto-loader.
 
 Totem comes with an IRB based console similar to Rails:
 
-    $ totem console
+    $ bundle exec totem console
+
+## Totem API
+
+Totem comes with some built in methods that should be familiar to any Rails developer.
+Copy and paste the below code into `app/my_class.rb`.
+You can then run this example in the console by entering `MyClass.new.run`.
+Don't forget, you need to register this class in `app/loader.rb` with `require my_class`.
+
+    class MyClass
+      def run
+        puts 'Totem provides a few class variables to simplify programming...'
+        puts "  Root: #{Totem.root}"
+        puts "  Environment: #{Totem.env}"
+        puts
+
+        puts 'Totem includes a logger...'
+        Totem.logger.error('Example error log entry')
+        puts "  Check your #{Totem.log_file_path} to see the entry."
+        puts
+
+        puts 'Enjoy!'
+      end
+    end
+
+## Add-ons
+
+Below is a list of available add-ons that extend the functionality of a Totem project:
+
+- [totem_activerecord](https://github.com/chadrem/totem_activerecord): The Rails database library
 
 ## Contributing
 

data/Rakefile

@@ -1,10 +1,11 @@
 require 'bundler/gem_tasks'
 
-desc 'Start a Totem interactive console'
+desc 'Start an IRB session'
 task :console do
   $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
   require 'totem'
 
-  Totem::Shell.new([:console]).run
+  ARGV.clear
+  IRB.start
 end

data/lib/totem.rb

@@ -13,8 +13,10 @@ module Totem
     @setup = true
     @root = root
     Bundler.require(Totem.env.to_sym)
+    run_callbacks(:before_load_app)
     $LOAD_PATH.unshift(root + '/app')
     load_app
+    run_callbacks(:after_load_app)
 
     return true
   end
@@ -51,6 +53,15 @@ module Totem
     return @logger
   end
 
+  def self.register_callback(type, callback=nil, &block)
+    @callbacks ||= {}
+    (@callbacks[type] ||= []) << (callback || block)
+
+    return true
+  end
+
+  private
+
   def self.log_to_stdout
     init_logger($stdout)
 
@@ -82,4 +93,11 @@ module Totem
 
     return nil
   end
+
+  def self.run_callbacks(type)
+    @callbacks ||= {}
+    (@callbacks[type] || []).each { |cb| cb.call }
+
+    return nil
+  end
 end

data/lib/totem/shell.rb

@@ -13,6 +13,14 @@ module Totem
     end
 
     def run
+      env_path = 'config/environment.rb'
+      if File.exists?(env_path)
+        load(env_path)
+      else
+        puts "Unable to find #{env_path}.  You must run this command from your project root directory."
+        exit
+      end
+
       if @args[0].nil?
         puts_usage
         return
@@ -42,7 +50,7 @@ module Totem
     private
 
     def puts_usage
-      puts "Usage:\n  totem <command>"
+      puts "Usage:\n  bundle exec totem <command>"
       puts
       puts "Commands:\n  #{self.class.cmds.keys.join(', ')}"
     end

data/lib/totem/shell_cmds/console.rb

@@ -4,14 +4,6 @@ module Totem
   module ShellCmds
     class Console < Totem::ShellCmds::Base
       def run
-        env_path = 'config/environment.rb'
-        if File.exists?(env_path)
-          load(env_path)
-        else
-          puts "Unable to find #{env_path}.  You must run this command from your project root directory."
-          exit
-        end
-
         ARGV.clear
         IRB.start
       end

data/lib/totem/version.rb

@@ -1,3 +1,3 @@
 module Totem
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/totem.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Totem::VERSION
   gem.authors       = ['Chad Remesch']
   gem.email         = ['chad@remesch.com']
-  gem.description   = %q{Totem is a framework for creating Ruby projects.}
+  gem.description   = %q{Totem is a Ruby gem for creating Ruby projects.}
   gem.summary       = %q{It's like having a Rails project folder without the Rails dependency.}
   gem.homepage      = 'https://github.com/chadrem/totem'
 
@@ -16,4 +16,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_development_dependency("bundler", "~> 1.5")
+  gem.add_development_dependency("rake")
 end

metadata

@@ -1,16 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: totem
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Chad Remesch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
-dependencies: []
-description: Totem is a framework for creating Ruby projects.
+date: 2014-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Totem is a Ruby gem for creating Ruby projects.
 email:
 - chad@remesch.com
 executables: