gk-application 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7e1e95fd9d6a2ab960a110027bf8f682a4ec305
+  data.tar.gz: 5aabedda707c4ab64a11aede7a2abf3a4d3b6046
+SHA512:
+  metadata.gz: 29d51509399af2a3315f37225915382cfe81a1eaf5f33313b26fadfeef0763283e53b8d3406897cee56fe2e573edf354e18c2f7ccf6d16cb5b5f006e8f90bae9
+  data.tar.gz: a68da36b2373ec89b55da2cf9e43d490d946cb8a125d3efe20105ffd61494bf48246e5b98abb0c482147248d6a45470eca3665d2555bf2307c78438cfe4f231f

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2014 Greg M. Krsak (greg.krsak@gmail.com)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,74 @@
+Gem: gk-application
+===================
+
+A simple framework for creating applications in Ruby
+----------------------------------------------------
+
+An instance of ```GK::Application``` allows you to easily mange your Ruby application's state, with minimal fuss. Supported states are ```:starting```, ```:running```, ```:stopping``` and ```:stopped```.
+
+Install with gem
+----------------
+
+Quick installation with ```gem```:
+
+```bash
+gem install gk-application
+```
+
+Get started with a new project
+------------------------------
+
+Need a project template? No problem:
+
+```bash
+ruby -e 'require "gk-application"' -e 'GK::Application.new.project'
+```
+
+Or using ```irb```:
+
+```
+$ irb
+irb(main):001:0> require 'gk-application'
+=> true
+irb(main):002:0> GK::Application.new.project
+=> nil
+irb(main):003:0> quit
+```
+
+And you'll have a brand-new ```my_app.rb``` ready to go in the current folder!
+
+Here's what an application looks like
+-------------------------------------
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'gk-application'
+
+
+my_app = GK::Application.new
+
+
+my_app.on_starting = Proc.new do
+  puts 'Starting.'
+  my_app.state = :running
+end
+
+my_app.on_running = Proc.new do
+  puts 'Running.'
+  my_app.state = :stopping
+end
+
+my_app.on_stopping = Proc.new do
+  puts 'Stopping.'
+  my_app.state = :stopped
+end
+
+my_app.on_stopped = Proc.new do
+  puts 'Stopped.'
+end
+
+
+my_app.state = :starting
+
+```

data/lib/gk-application.rb

@@ -0,0 +1,101 @@
+# gk-application.rb
+# GK::Application
+#
+# A simple framework for creating applications in Ruby
+#
+# Copyright 2014 Greg M. Krsak (greg.krsak@gmail.com)
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# 
+
+require 'fileutils'
+
+
+module GK
+
+class Application
+
+  # The name of this gem
+  GEM_NAME = 'gk-application'
+  # The name of the project template
+  TEMPLATE_PROJECT = 'my_app.rb'
+  # Custom exception messages
+  MSG_INVALID_STATE = 'This application does not support the requested state.'
+
+  # An Application instance's state may be one of
+  # :starting
+  # :running
+  # :stopping
+  # :stopped
+  def state
+    @state
+  end
+  def state=(new_state)
+    case new_state
+      when :starting
+        @on_starting.call
+      when :running
+        @on_running.call
+      when :stopping
+        @on_stopping.call
+      when :stopped
+        @on_stopped.call
+      else
+        raise MSG_INVALID_STATE
+    end
+  end
+
+  # State change event handlers
+  attr_accessor :on_starting
+  attr_accessor :on_running
+  attr_accessor :on_stopping
+  attr_accessor :on_stopped
+
+  # This is run once every time an Application instance is created
+  def initialize
+    # Initialize event handlers
+    @on_starting = Proc.new do 
+      state = :running 
+    end
+    @on_running = Proc.new do 
+      state = :stopping 
+    end
+    @on_stopping = Proc.new do
+      state = :stopped
+    end
+    @on_stopped = Proc.new { }
+    # Always create the Application instance in the stopped state
+    state = :stopped
+  end
+
+  # This creates a new GK::Application project.
+  # The new application will be called "my_app.rb" and be placed in the
+  # current directory unless otherwise specified.
+  def project(name: TEMPLATE_PROJECT)
+    # Get the path for the gk-application gem
+    spec = Gem::Specification.find_by_name(GEM_NAME)
+    gem_root = spec.gem_dir
+    source_file = File.join(gem_root, TEMPLATE_PROJECT);
+    # Create the target folder if it doesn't exist
+    target_dir = File.dirname(name)
+    FileUtils.mkdir_p(target_dir)
+    # Copy the my_app.rb file (in the gem directory) to the target
+    target_file = File.join(target_dir, name)
+    FileUtils.cp(source_file, target_file)
+  end
+
+end # Class
+
+end # Module
+
+# End of gk-application.rb

data/my_app.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'gk-application'
+
+
+my_app = GK::Application.new
+
+
+my_app.on_starting = Proc.new do
+  puts 'Starting.'
+  my_app.state = :running
+end
+
+my_app.on_running = Proc.new do
+  puts 'Running.'
+  my_app.state = :stopping
+end
+
+my_app.on_stopping = Proc.new do
+  puts 'Stopping.'
+  my_app.state = :stopped
+end
+
+my_app.on_stopped = Proc.new do
+  puts 'Stopped.'
+end
+
+
+my_app.state = :starting

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: gk-application
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Greg M. Krsak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-10 00:00:00.000000000 Z
+dependencies: []
+description: An instance of GK::Application allows you to easily mange your Ruby application's
+  state, with minimal fuss. Supported states are :starting, :running, :stopping and
+  :stopped.
+email:
+- greg.krsak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/gk-application.rb
+- my_app.rb
+homepage: http://github.com/gregkrsak/gk-application
+licenses:
+- Apache-2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple framework for creating applications in Ruby
+test_files: []