totem 0.0.1 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7dd860951dbcc374badc7017f380f07a8aa36d1
+  data.tar.gz: 5e81108d1c625256ddefe12d65b312ba7035d33c
+SHA512:
+  metadata.gz: 3f0a3b77364746a25eb863f7238401c67a0c850520084bf81a0c4d5eac1f3cbb8020624864c32f982a788f9eb8766fa798347bdd9202ff1ac4d3b3c5e0ed46d3
+  data.tar.gz: 2bdba58062c6acea84cb16b5a636a8872d5c67a92ad55b8bc6701b245415044c9f24150e34d46e1bc1aeed096f01eddbf3c16f6f71d867c04a62aeede8347527

data/.gitignore

@@ -17,3 +17,5 @@ test/version_tmp
 tmp
 *.swp
 .rvmrc
+.ruby-version
+.ruby-gemset

data/README.md

@@ -1,14 +1,18 @@
 # Totem
 
-Totem is a framework for writing actor model based servers using the Ruby language.
-Currently it is in an experimental state, but you are welcome to play with it.
+Totem is a framework for creating Ruby projects.
+It's like having a Rails project folder without the Rails dependency.
 
 Features:
 - Ruby on Rails inspired folder structure.
-- Includes Active Record and Active Support.
-- Generators for database migrations.
+- 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 (coming soon).
+  - Tribe (coming soon).
+- Designed for multi-threaded applications.
 
 ## Installation
 

data/Rakefile

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

data/bin/totem

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'totem'
+
+Totem::Shell.new(ARGV).run

data/lib/totem.rb

@@ -1,13 +1,10 @@
-require 'tribe'
-require 'tribe_em'
+require 'logger'
 
 require 'totem/version'
-require 'totem/tasks/console'
-require 'totem/tasks/database'
-require 'totem/tasks/generator'
-require 'totem/actable'
-require 'totem/connection'
-require 'totem/tcp_server'
+require 'totem/shell'
+require 'totem/shell_cmds/base'
+require 'totem/shell_cmds/console'
+require 'totem/shell_cmds/new'
 
 module Totem
   def self.initialize(root)
@@ -15,10 +12,8 @@ module Totem
 
     @setup = true
     @root = root
-
     Bundler.require(Totem.env.to_sym)
-    Time.zone = 'UTC'
-    db_connect
+    $LOAD_PATH.unshift(root + '/app')
     load_app
 
     return true
@@ -29,79 +24,19 @@ module Totem
   end
 
   def self.env
-    return (@env ||= (ENV['GAME_SRV_ENV'] || 'development'))
-  end
-
-  def self.settings
-    return @settings if @settings
-
-    begin
-      @settings = Fiona::Settings.new do |s|
-        eval(File.read(File.join(root, 'config', 'settings.rb')))
-      end
-    rescue Exception => e
-      puts "Failed to initialize settings: #{e.message}\n#{e.backtrace.join("\n")}"
-    end
-
-    return @settings
-  end
-
-  def self.db_config
-    return (@db_config ||= YAML.load_file(File.join(root, 'config', 'database.yml'))[env])
-  end
-
-  def self.db_connect
-    return false if db_connected?
-
-    begin
-      ActiveRecord::Base.establish_connection(Totem.db_config)
-    rescue Exception => e
-      puts "Failed to establish DB connection: #{e.message}\n#{e.backtrace.join("\n")}"
-      return false
-    end
-
-    return true
-  end
-
-  def self.db_disconnect
-    return false unless db_connected?
-
-    ActiveRecord::Base.connection_pool.disconnect!
-
-    return true
-  end
-
-  def self.db_reconnect
-    db_disconnect
-    db_connect
-
-    return true
-  end
-
-  def self.db_connected?
-    return !!ActiveRecord::Base.connected?
+    return (@env ||= (ENV['TOTEM_ENV'] || 'development'))
   end
 
   def self.load_app
-    Dir.chdir("#{Totem.root}/app")
-    load("loader.rb")
-    Dir.chdir(Totem.root)
+    require "#{Totem.root}/app/loader.rb"
   end
 
   def self.component
-    return @component || 'default'
-  end
-
-  def self.component=(val)
-    return @component = val
+    return @component ||= ENV['TOTEM_COMPONENT']
   end
 
   def self.instance
-    return @instance || 0
-  end
-
-  def self.instance=(val)
-    return @instance = val
+    return @instance || ENV['TOTEM_INSTANCE']
   end
 
   def self.logger=(val)
@@ -111,14 +46,7 @@ module Totem
   def self.logger
     return @logger if @logger
 
-    case env
-    when 'development'
-      log_to_stdout
-    when 'production'
-      log_to_file
-    else
-      log_to_stdout
-    end
+    log_to_file
 
     return @logger
   end
@@ -129,15 +57,25 @@ module Totem
     return nil
   end
 
+  def self.log_file_path
+    name = env
+    name << "_#{component}" if component && component.length > 0
+    name << "_#{instance}" if instance && instance.length > 0
+    name << '.log'
+
+    return File.join(root, 'log', name)
+  end
+
   def self.log_to_file
-    init_logger(File.join(root, 'log', "#{env}_#{component}_#{instance}.log"))
+    init_logger(log_file_path)
 
     return nil
   end
 
   def self.init_logger(output)
-    @logger = Logger.new(output)
+    raise 'Logger is already initialized' if @logger
 
+    @logger = Logger.new(output)
     @logger.formatter = proc do |severity, datetime, progname, msg|
       "#{datetime} :: #{msg}\n"
     end

data/lib/totem/shell.rb

@@ -0,0 +1,36 @@
+module Totem
+  class Shell
+    @cmds = {}
+
+    def self.register_cmd(cmd, klass)
+      @cmds[cmd.to_sym] = klass
+
+      return nil
+    end
+
+    def initialize(args)
+      @args = args
+    end
+
+    def run
+      if @args[0].nil?
+        puts "Usage:\n  totem <command>"
+        puts
+        puts "Commands:\n  #{self.class.cmds.keys.join(', ')}"
+        return
+      end
+
+      cmd_to_class(@args[0]).new(@args[1..-1]).run
+    end
+
+    private
+
+    def self.cmds
+      return @cmds
+    end
+
+    def cmd_to_class(cmd)
+      return self.class.cmds[cmd.to_sym] || raise("Unknown cmd: #{cmd}")
+    end
+  end
+end

data/lib/totem/shell_cmds/base.rb

@@ -0,0 +1,13 @@
+module Totem
+  module ShellCmds
+    class Base
+      def initialize(args)
+        @args = args
+      end
+
+      def run
+        raise 'You must implement this method in a subclass.'
+      end
+    end
+  end
+end

data/lib/totem/shell_cmds/console.rb

@@ -0,0 +1,14 @@
+require 'irb'
+
+module Totem
+  module ShellCmds
+    class Console < Totem::ShellCmds::Base
+      def run
+        ARGV.clear
+        IRB.start
+      end
+    end
+  end
+end
+
+Totem::Shell.register_cmd(:console, Totem::ShellCmds::Console)

data/lib/totem/shell_cmds/new.rb

@@ -0,0 +1,52 @@
+require 'erb'
+
+module Totem
+  module ShellCmds
+    class New < Totem::ShellCmds::Base
+      def run
+        if @args[0].nil?
+          puts "You must provide a name for the new project."
+          return
+        end
+
+        root_path = @args[0]
+
+        puts 'Creating project root directory...'
+        Dir.mkdir(root_path)
+        puts
+
+        puts 'Creating sub-directories...'
+        %w(app config log tmp).each do |dir|
+          puts "  #{dir}..."
+          Dir.mkdir(root_path + '/' + dir)
+        end
+        puts
+
+        template_path = File.expand_path(File.dirname(__FILE__) + '/../../../templates')
+
+        puts 'Creating Gemfile...'
+        input = File.read(template_path + '/Gemfile.erb')
+        output = ERB.new(input).result(binding)
+        File.open(root_path + '/Gemfile', 'w') { |f| f.write(output) }
+        puts
+
+        puts 'Creating config/environment.rb...'
+        input = File.read(template_path + '/config/environment.rb.erb')
+        output = ERB.new(input).result(binding)
+        File.open(root_path + '/config/environment.rb', 'w') { |f| f.write(output) }
+        puts
+
+        puts 'Creating app/loader.rb...'
+        input = File.read(template_path + '/app/loader.rb.erb')
+        output = ERB.new(input).result(binding)
+        File.open(root_path + '/app/loader.rb', 'w') { |f| f.write(output) }
+        puts
+
+        puts 'Finished! You must now run "bundle update" inside your project directory.'
+      end
+
+    end
+  end
+end
+
+Totem::Shell.register_cmd(:new, Totem::ShellCmds::New)

data/lib/totem/version.rb

@@ -1,3 +1,3 @@
 module Totem
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
 end

data/templates/Gemfile.erb

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'totem', :git => 'https://github.com/chadrem/totem.git'

data/templates/app/loader.rb.erb

@@ -0,0 +1,2 @@
+# Manually require your application classes here.
+# Example: require 'my_class'

data/templates/config/environment.rb.erb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+Bundler.require(:default)
+
+Totem.initialize(File.expand_path(File.dirname(__FILE__) + '/../'))

data/totem.gemspec

@@ -8,15 +8,12 @@ Gem::Specification.new do |gem|
   gem.version       = Totem::VERSION
   gem.authors       = ['Chad Remesch']
   gem.email         = ['chad@remesch.com']
-  gem.description   = %q{The Totem framework.}
-  gem.summary       = %q{An actor model based framework for rapid server server side development.}
+  gem.description   = %q{Totem is a framework 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'
 
   gem.files         = `git ls-files`.split($/)
   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_dependency('tribe', '0.0.8')
-  gem.add_dependency('tribe_em', '0.0.2')
 end

metadata

@@ -1,91 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: totem
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Chad Remesch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: tribe
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.0.8
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.0.8
-- !ruby/object:Gem::Dependency
-  name: tribe_em
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-description: The Totem framework.
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies: []
+description: Totem is a framework for creating Ruby projects.
 email:
 - chad@remesch.com
-executables: []
+executables:
+- totem
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/totem
 - lib/totem.rb
-- lib/totem/actable.rb
-- lib/totem/connection.rb
-- lib/totem/tasks/console.rb
-- lib/totem/tasks/database.rb
-- lib/totem/tasks/generator.rb
-- lib/totem/tcp_server.rb
+- lib/totem/shell.rb
+- lib/totem/shell_cmds/base.rb
+- lib/totem/shell_cmds/console.rb
+- lib/totem/shell_cmds/new.rb
 - lib/totem/version.rb
+- templates/Gemfile.erb
+- templates/app/loader.rb.erb
+- templates/config/environment.rb.erb
 - totem.gemspec
 homepage: https://github.com/chadrem/totem
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: An actor model based framework for rapid server server side development.
+specification_version: 4
+summary: It's like having a Rails project folder without the Rails dependency.
 test_files: []

data/lib/totem/actable.rb

@@ -1,9 +0,0 @@
-module Totem
-  module Actable
-    def process_event(event)
-      ActiveRecord::Base.connection_pool.with_connection do
-        super
-      end
-    end
-  end
-end

data/lib/totem/connection.rb

@@ -1,13 +0,0 @@
-module Totem
-  class Connection < Tribe::EM::Connection
-    include Totem::Actable
-
-    private
-
-    def initialize(options = {})
-      options[:logger] = Totem.logger
-
-      super
-    end
-  end
-end

data/lib/totem/tasks/console.rb

@@ -1,10 +0,0 @@
-module Totem
-  module Tasks
-    class Console
-      def start
-        ARGV.clear
-        IRB.start
-      end
-    end
-  end
-end

data/lib/totem/tasks/database.rb

@@ -1,68 +0,0 @@
-module Totem
-  module Tasks
-    class Database
-      def initialize
-        @config = Totem.db_config.clone
-      end
-
-      def create
-        options = { :charset => 'utf8', :collation => 'utf8_unicode_ci' }
-
-        create_db = lambda do |config|
-          ActiveRecord::Base.establish_connection(config.merge('database' => nil))
-          ActiveRecord::Base.connection.create_database(config['database'], options)
-          ActiveRecord::Base.establish_connection(config)
-        end
-
-        begin
-          create_db.call(@config)
-        rescue Mysql::Error => sqlerr
-          if sqlerr.errno == 1405
-            print "#{sqlerr.error}. \nPlease provide the root password for your mysql installation\n>"
-            root_password = $stdin.gets.strip
-
-            grant_statement = <<-SQL
-              GRANT ALL PRIVILEGES ON #{config['database']}.*
-                TO '#{config['username']}'@'localhost'
-                IDENTIFIED BY '#{config['password']}' WITH GRANT OPTION;
-            SQL
-
-            create_db.call(@config.merge('database' => nil, 'username' => 'root', 'password' => root_password))
-          else
-            $stderr.puts sqlerr.error
-            $stderr.puts "Couldn't create database for #{config.inspect}, charset: utf8, collation: utf8_unicode_ci"
-            $stderr.puts "(if you set the charset manually, make sure you have a matching collation)" if config['charset']
-          end
-        end
-
-        Totem.db_reconnect
-
-        return true
-      end
-
-      def drop
-        ActiveRecord::Base.connection.drop_database(@config['database'])
-
-        return true
-      end
-
-      def migrate
-        ActiveRecord::Migration.verbose = true
-        ActiveRecord::Migrator.migrate('db/migrate', ENV['VERSION'] ? ENV['VERSION'].to_i : nil)
-
-        Totem.db_reconnect
-
-        return true
-      end
-
-      def rollback
-        step = ENV['STEP'] ? ENV['STEP'].to_i : 1
-        ActiveRecord::Migrator.rollback('db/migrate', step)
-
-        Totem.db_reconnect
-
-        return true
-      end
-    end
-  end
-end

data/lib/totem/tasks/generator.rb

@@ -1,29 +0,0 @@
-module Totem
-  module Tasks
-    class Generator
-      def migration(name)
-        tstamp =  Time.now.utc.strftime("%Y%m%d%H%M%S")
-        fname = "#{tstamp}_#{name}.rb"
-        path = File.join(Totem.root, 'db', 'migrate', fname)
-
-        name || raise('You must specify a name')
-
-        puts "Creating migration: #{path}"
-
-        if File.exists?(path)
-          puts 'ERROR: File already exists.'
-          return
-        end
-
-        content = <<-EOS.unindent
-          class #{name.camelize} < ActiveRecord::Migration
-          end
-        EOS
-
-        File.open(path, 'w') { |f| f.write(content) }
-
-        return nil
-      end
-    end
-  end
-end

data/lib/totem/tcp_server.rb

@@ -1,13 +0,0 @@
-module Totem
-  class TcpServer < Tribe::EM::TcpServer
-    include Totem::Actable
-
-    private
-
-    def initialize(ip, port, conn_class, options = {})
-      options[:logger] = Totem.logger
-
-      super
-    end
-  end
-end