teamster 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58ff0d4b5486fe8ef3501955b44d7d194e959bda
-  data.tar.gz: 64b79fea2e60fa4e8be84aa140a37f2dd7597249
+  metadata.gz: 408dd6c1de8da8854d489bddfd6a08ca8543a70d
+  data.tar.gz: 5eae8abb7fe45335457bb8d81d18411850a61b05
 SHA512:
-  metadata.gz: f1126346b2484ac18fa2d1b0227127f95f8da2f09c52e20ab0383a0736056dbc55c7be8ef233b3d42cadec097fb54dc91a0495fd78aa2a954e8a7f353e1171d1
-  data.tar.gz: c3436c9579eeeb9334430bdf8790f9ed66f9a04c5a78a3650580f8389c98c002270feb9074984b367814d89298f61af4680838ab8ef33398637e99b2320e978c
+  metadata.gz: d499d7be8553ed8bf83e0dd16f3d7690238ecef12ae0c72f772b8594072b3ae5b4a07c5f410e3f245f467d43b7f921cb4307b82ee9811f37a76cbfc8ff712460
+  data.tar.gz: 1dd7a0f717d19dfc0222e88faa092106ea36d7441ee7905638e513823b7cd15d850f1611d4dac142e9251c49371fcf7de42a36caff573dbeb3b62d92aef2f717

data/README.md

@@ -0,0 +1,76 @@
+teamster
+========
+
+A simple bare-bones extensible web portal for individuals or small teams
+
+
+Dependencies
+============
+
+To run teamster, there is a few dependencies:
+
+* Only supported in OS X and linux. Not test on Windows. YMMV.
+
+Install
+=======
+
+Teamster has been packaged into a gem. To install, simply run `gem install teamster`.
+
+
+Usage
+=====
+
+* Create a new folder where you want your site to live and navigate into it: `mkdir new-site && cd new-site`
+* Initialize teamster and answer some configuration questions: `teamster init`
+* Run teamster: `teamster start`
+
+Open a browser and point to http://localhost:9292. A bare teamster page should be shown.
+
+
+Running In A "Production" Environment
+=====================================
+
+I do not recommended this application be exposed to the wide Internet just yet, but it should be secure enough for an individual or small team to use over their private LAN.
+
+When the `--prod` flag is passed, teamster will not run using rackup, but will utilize the [Puma](http://puma.io/) app server to serve itself. It will create and bind itself to a UNIX socket file and a Puma state file.
+
+Use With Nginx
+--------------
+
+Personally, I'm using this in conjunction with the popular [Nginx](http://nginx.org/) web server. To follow these, Nginx must already be installed on your system.
+
+* Run teamster in production mode: `teamster start --prod --socket-file /tmp/teamster.sock --state-file /srv/my-site/app.state`
+* In the nginx site configuration file, add the following:
+
+ > upstream app {
+ >   server unix:///tmp/teamster.sock;
+ > }
+ >
+ > server {
+ >   server_name my-site.example.com;
+ > }
+ >
+ >   location / {
+ >     proxy_pass http://app;
+ >   }
+ > }
+
+* Restart nginx.
+
+Open a browser and point to http://my-site.example.com. A bare teamster page should be shown.
+
+
+Create Modules
+==============
+
+To create your custom modules:
+
+* Navigate to the site folder root: `cd /path/to/root/folder/of/my-site`
+* Run: `teamster --create-module MODULENAME`.
+
+This will create the following files in your site folder:
+
+* lib/teamster-modules/MODULENAME.rb
+* lib/teamster-modules/MODULENAME/views/MODULENAME.erb
+
+In MODULENAME.rb, a class MODULENAME will be created. While it may sub-class from Teamster::Module::Base, it is also a sub-class of Sinatra::Base. When developing it, you can use helper methods and other nifty stuff available from Sinatra. However, do take note of the scoping.

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/bin/teamster

@@ -135,10 +135,14 @@ class TeamsterApp
       puts "Creating placeholders for module #{name}...\n"
       FileUtils.mkdir_p "lib/teamster-modules/#{name}/views"
       create_file "lib/teamster-modules/#{name}.rb", "module_placeholder_for", name
+      create_file "lib/teamster-modules/#{name}/#{name}_helper.rb", "module_helper_placeholder_for", name
       create_file "lib/teamster-modules/#{name}/views/#{name}.erb", "view_placeholder_for", name
+      create_file "lib/teamster-modules/#{name}/views/#{name}_summary.erb", "view_summary_placeholder_for", name
       puts "\nBasic module creation done!"
-      puts "Controller : \"lib/teamster-modules/#{name}.rb\""
-      puts "View       : \"lib/teamster-modules/#{name}/views/#{name}.erb\""
+      puts "Controller   : \"lib/teamster-modules/#{name}.rb\""
+      puts "Helper       : \"lib/teamster-modules/#{name}/#{name}_helper.rb\""
+      puts "View         : \"lib/teamster-modules/#{name}/views/#{name}.erb\""
+      puts "Summary View : \"lib/teamster-modules/#{name}/views/#{name}_summary.erb\""
     end
 
     def create_file(filename, method, *args)
@@ -229,17 +233,44 @@ end
 
     def module_placeholder_for(name)
       <<-CODE
-class #{name.capitalize} < ::Teamster::Modules::Base
-  \# Stuff that needs to be done before registration with core.
-  has_helpers nil   \# Add array of modules here if there are helper modules.
-  views_at \"\#\{File.dirname(__FILE__)\}/#{name}/views\"
-  under_development \# Remove this line when development is finished.
+require_relative \"#{name}/#{name}_helper\"
 
-  \# Register this class so it can be used.
-  register self
+\# NOTE: If the namespace is changed, please take care of the
+\#       namespace of the sub-class and helper modules.
 
-  get '/#{name}/?' do
-    erb :#{name}
+module Teamster
+  module Modules
+    class #{name.capitalize} < Base
+      \# Stuff that needs to be done before registration with core.
+      has_helpers #{name.capitalize}Helper \# Add modules here (comma separated) if there are helper modules.
+      views_at \"\#\{File.dirname(__FILE__)\}/#{name}/views\"
+      under_development \# Remove this line when development is finished.
+
+      \# Register this class so it can be used.
+      register self
+
+      get '/#{name}/?' do
+        erb :#{name}
+      end
+    end
+  end
+end
+      CODE
+    end
+
+    def module_helper_placeholder_for(name)
+      <<-CODE
+module Teamster
+  module Modules
+    module #{name.capitalize}Helper
+      def #{name}_summary?
+        true
+      end
+
+      def #{name}_summary
+        erb :#{name}_summary
+      end
+    end
   end
 end
       CODE
@@ -251,6 +282,12 @@ end
 <p style='text-align: center'>Page under construction. Please check back later!</p>
       CODE
     end
+
+    def view_summary_placeholder_for(name)
+      <<-CODE
+<p>Under development right now..</p>
+      CODE
+    end
   end
 end
 

data/content/views/index.erb

@@ -1,7 +1,7 @@
 <h1 class='text-center'>Status At A Glance</h1>
 <hr class="fancy-line">
 <div class='row'>
-  <% available_modules(true).each_with_index do |arr, i| %>
+  <% all_modules(true).each_with_index do |arr, i| %>
     <% link, name = arr %>
     <div class=<%= summary_div_class_for i%>>
       <div class="frontpage-panel panel panel-default">

data/lib/teamster/base_module.rb

@@ -10,7 +10,7 @@ module Teamster
           if mods.size > 0
             instance_eval "def has_helper?; true end"
             instance_eval "def helper_module; #{mods} end"
-            mods.each {|mod| helpers mod }
+            mods.flatten.each {|mod| helpers mod }
           end
         end
 

data/lib/teamster/general_helper.rb

@@ -54,6 +54,16 @@ module Teamster
         end
       end
 
+      def all_modules(shuffle = false)
+        all_modules = [].tap do |arr|
+          App.modules.each do |mod|
+            module_name = mod.to_s.split("::").last
+            arr << ['/' + module_name.downcase, module_name]
+          end
+        end
+        shuffle ? all_modules.shuffle : all_modules
+      end
+
       def find_template(views, name, engine, &block)
         App.views.each {|v| super(v, name, engine, &block)}
       end

data/lib/teamster.rb

@@ -13,8 +13,8 @@ module Teamster
       @@title     = 'TEAMSTER'
       CORE_CONFIG = 'conf/teamster.conf'
 
-      # NOTE: Methods used in configure block needs be declared before
-      #       the configure block.
+      # NOTE: Class methods used in configure block needs be declared
+      #       before the configure block.
       def self.set_default_options_from(core_opts)
         @@title = core_opts[:title]
       end
@@ -40,8 +40,10 @@ module Teamster
       end
 
       def summary_div_class_for(index)
-        size = available_modules.size
-        if size%2 == 0
+        size = all_modules.size
+        if size == 1
+          "col-lg-12"
+        elsif size%2 == 0
           "col-lg-6"
         else
           last = size - 1
@@ -58,7 +60,6 @@ module Teamster
         end
       end
 
-      # NOTE: Class methods here are for module processing.
       def self.modules
         @@modules
       end
@@ -80,7 +81,7 @@ module Teamster
         end
         teamster_module.helpers GeneralHelper
         if teamster_module.has_helper?
-          teamster_module.helper_module.each do |mod|
+          teamster_module.helper_module.flatten.each do |mod|
             helpers mod
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamster
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Nur Muhammad Bin Sirat
@@ -49,6 +49,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
+- README.md
 - Rakefile
 - VERSION
 - bin/teamster