widget 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "commandable", "0.2.0.beta2"
+gem "hashmodel", "0.4.0.beta2"
+
+group :development do
+  gem "rspec", "2.5.0"
+  gem "aruba", "0.3.3"
+  gem "cucumber", "0.10.0"
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    widget (0.0.1)
+      commandable (= 0.2.0.beta2)
+      hashmodel (= 0.4.0.beta2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.3.3)
+      childprocess (~> 0.1.7)
+      cucumber (~> 0.10)
+      rspec (~> 2.5)
+    builder (3.0.0)
+    childprocess (0.1.7)
+      ffi (~> 0.6.3)
+    commandable (0.2.0.beta2)
+      term-ansicolor-hi (~> 1.0.7)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    file-tail (1.0.5)
+      spruz (>= 0.1.0)
+    gherkin (2.3.5)
+      json (>= 1.4.6)
+    hashmodel (0.4.0.beta2)
+      file-tail
+      sourcify
+    json (1.4.6)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
+    sourcify (0.4.2)
+      file-tail (>= 1.0.5)
+      ruby2ruby (>= 1.2.5)
+      sexp_processor (>= 3.0.5)
+    spruz (0.2.5)
+    term-ansicolor (1.0.5)
+    term-ansicolor-hi (1.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (= 0.3.3)
+  commandable (= 0.2.0.beta2)
+  cucumber (= 0.10.0)
+  hashmodel (= 0.4.0.beta2)
+  rspec (= 2.5.0)
+  widget!

data/LICENCE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mike Bethany
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,33 @@
+# Widget #
+
+It does stuff and things!
+
+## Description ##
+
+No matter how many specs I write I always find trying to use a thing is a sure way of finding out what it's lacking and where it doesn't actually work. This app is the testbed for doing just that with two of my Gems: [Commandable][], the easiest way to add command line control to your Ruby apps, and [HashModel][] a hash based MVC model that makes searching and updating deeply nested hashes a breeze.
+
+## Functionality ##
+
+It makes widgets of course.
+
+## Instructions ##
+
+You can install it as a Gem by running:
+
+    rake install
+
+You can then run it by just typing:
+
+    widget
+
+Or run it as is by typing
+
+    bin/widget <command> [parameter]
+
+To see what it can do type
+
+    widget help
+
+
+[HashModel]: https://github.com/mikbe/hashmodel
+[Commandable]: https://github.com/mikbe/commandable

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => [:build]

data/_test/marshal.rb

@@ -0,0 +1,20 @@
+require 'hashmodel'
+
+# puts hm
+# data = Marshal.dump(hm)
+#File.new("dummy.hashmodel", "r")
+
+hashmodel_file = "widget.hashmodel"
+
+hm = HashModel.new
+hm.add(:name=>"Phish")
+
+File.open(hashmodel_file, "w"){|file| file.write(Marshal.dump(HashModel.new))} unless File.exist?(hashmodel_file)
+
+hmo = Marshal.load(File.open(hashmodel_file, "r"))
+
+puts hmo.class
+puts hmo
+
+# hm.add(:name=>"Widgee 5")
+# put hm

data/autotest/discover.rb

@@ -0,0 +1,2 @@
+Autotest.add_discovery {"rspec2"}
+

data/bin/widget

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '/../lib'))
+require 'widget'
+
+# Now run command the user specified on the command line
+Commandable.execute(ARGV)

data/features/setup/env.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'cucumber'
+require 'rspec/expectations'
+require 'aruba/cucumber'
+require 'widget'

data/features/step-definitions/step-definitions.rb

@@ -0,0 +1,22 @@
+Before do
+  file_name = File.expand_path((File.dirname(__FILE__) + '/../../db/hashmodel.dat'))
+  File.delete(file_name) if File.exists?(file_name)
+  Widget::Data.reset_instance
+  @data = Widget::Data.instance
+end
+
+Given /^I have a widget named "([^"]*)"$/ do |name|
+  @data.create(name)
+end
+
+Given /^There are no widgets$/ do
+  @data.delete_all
+end
+
+Given /^I have (\d+) widgets named "([^"]*)"$/ do |count, name|
+  (1..count.to_i).each{|n| @data.create(name.gsub("\#{n}", n.to_s))}
+end
+
+Then /^the output should contain (\d+) lines matching "([^"]*)"$/ do |count, line|
+  (1..count.to_i).each{|n| all_output.should =~ Regexp.new(line.gsub("\#{n}", n.to_s))}
+end

data/features/support/helpers.rb

@@ -0,0 +1,15 @@
+# Allow an instance class to be "reset"
+require 'singleton'
+class <<Singleton
+  def included_with_reset(klass)
+    included_without_reset(klass)
+    class <<klass
+      def reset_instance
+        Singleton.send :__init__, self
+        self
+      end
+    end
+  end
+  alias_method :included_without_reset, :included
+  alias_method :included, :included_with_reset
+end

data/features/widget_creation.feature

@@ -0,0 +1,13 @@
+Feature: Create Widgets
+  In order to have widgets
+  As a Widget user
+  I want to be able to create a widget
+
+  Scenario: Create a new widget
+    When I run "widget new 'Widgee 5'"
+    Then the output should contain "You created widget Widgee 5"
+
+  Scenario: Try to create a widget that already exists
+    Given I have a widget named "Widgee 5"
+     When I run "widget new 'Widgee 5'"
+    Then the output should contain "Widgee 5 already exists!"

data/features/widget_deletion.feature

@@ -0,0 +1,18 @@
+Feature: Delete Widgets
+  In order to get rid of widgets I don't want
+  As a Widget user
+  I want to be able delete widgets
+
+  Scenario: Removing all widgets
+    When I run "widget reset"
+    Then the output should contain "All widgets destroyed"
+
+  Scenario: Remove a widget by name
+    Given I have a widget named "Widgee 5"
+    When I run "widget destroy 'Widgee 5'"
+    Then the output should contain "Widgee 5 destroyed"
+
+  Scenario: Try to remove a widget that doesn't exist
+    Given There are no widgets
+    When I run "widget destroy 'Widgee 5'"
+    Then the output should contain "There is no Widgee 5 in storage"

data/features/widget_details.feature

@@ -0,0 +1,20 @@
+Feature: Show Widget details
+  In order to know all about my widgets
+  As a Widget user
+  I want to be able to show their details
+
+  Scenario: Show a widget's details
+    Given I have a widget named "Widgee 1"
+     When I run "widget show 'Widgee 1'"
+    Then the output should match /Widgee 1: created:(.*)modified(.*)/
+
+  Scenario: Try to show a widget that doesn't exist
+    Given There are no widgets
+     When I run "widget show 'Widgee 1'"
+    Then the output should contain "There is no Widgee 1 in storage"
+
+  Scenario: Show all widget detail
+    Given I have 5 widgets named "Widgee #{n}"
+     When I run "widget show"
+    Then the output should contain 5 lines matching "Widgee #{n}: created:(.*)modified(.*)"
+

data/features/widget_list_names.feature

@@ -0,0 +1,14 @@
+Feature: List Widgets
+  In order to know widgets I have
+  As a Widget user
+  I want to be able to list the names of my widgets
+
+  Scenario: List widget names
+    Given I have 5 widgets named "Widgee #{n}"
+     When I run "widget list"
+     Then the output should contain 5 lines matching "Widgee #{n}"
+
+  Scenario: Listing when there are no widgets
+    Given There are no widgets
+     When I run "widget list"
+     Then the output should contain "<none>"

data/features/widget_upgrade.feature

@@ -0,0 +1,14 @@
+Feature: Show Widget details
+  In order to make my widgets better
+  As a Widget user
+  I want to be able to upgrade my widgets
+
+  Scenario: Upgrade a widget
+    Given I have a widget named "Widgee 1"
+     When I run "widget upgrade 'Widgee 1'"
+    Then the output should contain "You just gave Widgee 1 a fresh coat of paint!"
+
+  Scenario: Try to upgrade a widget that doesn't exist
+    Given There are no widgets
+     When I run "widget upgrade 'Widgee 1'"
+    Then the output should contain "There is no Widgee 1 in storage"

data/lib/widget/commandable_config.rb

@@ -0,0 +1,10 @@
+# Configure Commandable
+require 'commandable'
+Commandable.color_output = true
+Commandable.verbose_parameters = false
+Commandable.app_name = "commandable"
+Commandable.app_info =
+"""
+  \e[92mWidget!\e[0m - It makes stuff and things! Exclamation!
+  Copyright (c) 2112 Richard Christy & Sal Governale
+"""

data/lib/widget/version.rb

@@ -0,0 +1,3 @@
+module Widget
+  VERSION = "0.0.1"
+end

data/lib/widget/widget_data.rb

@@ -0,0 +1,81 @@
+require 'hashmodel'
+require 'singleton'
+require 'time'
+
+module Widget
+  class Data
+    include Singleton
+        
+    def initialize(clean_slate=false)
+      hm = HashModel.new
+      save_widgets(HashModel.new) unless File.exist?(HASHMODEL_FILE) || clean_slate
+      @widgets = load_widgets
+    end
+    
+    def length
+      @widgets.length
+    end
+    alias :count :length
+    
+    # CRUD
+    
+    def create(name)
+      return false unless @widgets.where(name).empty?
+      time_now = now
+      @widgets.add(:name=>name, :created_at=>time_now, :modified_at=>time_now)
+      save_widgets
+      true
+    end
+  
+    def read(name)
+      @widgets.where(name)
+    end
+
+    def update(name)
+      # note the destructive update! method
+      changed = !(@widgets.update!(name, :modified_at=>now).empty?)
+      save_widgets
+      changed
+    end
+    
+    def delete(name)
+      return false if @widgets.where(name).empty?
+      @widgets.delete!(name)
+      save_widgets
+      true
+    end
+
+    # CRUD helpers
+    
+    def delete_all
+      @widgets.clear
+      save_widgets
+    end
+    
+    def read_all
+      @widgets.clone
+    end
+    
+    def reload
+      load_widgets
+    end
+    
+    private
+
+    HASHMODEL_FILE = File.expand_path((File.dirname(__FILE__) + '/../../db/hashmodel.dat'))
+    
+    def load_widgets
+       Marshal.load(File.open(HASHMODEL_FILE, "r"))
+    end
+
+    def save_widgets(widget=@widgets)
+      File.open(HASHMODEL_FILE, "w"){|file| file.write(Marshal.dump(widget))}
+    end
+
+    def now
+      Time.now.xmlschema(4)
+    end
+
+  end
+
+end

data/lib/widget/widget_viewtroller.rb

@@ -0,0 +1,80 @@
+module Widget
+  class Viewtroller
+    extend Commandable
+
+    # You shouldn't try to call initialize using Commandable because it creates a new
+    # class automatically for instance methods.
+    # 
+    # Think of the classes you let Commandable control as entry points to your app.
+    # Don't try to have Commandable do a lot of class creation and manipulation of
+    # your application, just have the methods you call do all that.
+    def initialize
+      @data = Data.instance
+    end
+
+    command "create a new widget"
+    # The method name "new" makes sense here but notice it's not the class.new method
+    def new(name)
+      if @data.create(name)
+        "You created widget #{name}"
+      else
+        "#{name} already exists!"
+      end
+    end
+    command "add a new widget"
+    alias :add :new
+
+    command "show a widget's details, if no name is given shows all widgets"
+    def show(name=nil)
+      if name 
+        widgets = @data.read(name)
+        return "There is no #{name} in storage." if widgets.empty?
+      else
+        widgets = @data.read_all
+        return "There are no widgets in storage." if widgets.empty?
+      end
+      print_widgets(widgets)
+    end
+
+    def print_widgets(widgets)
+      widgets.collect{|widget| " #{widget[:name]}: created: #{widget[:created_at]}; modified: #{widget[:modified_at]};"}
+    end
+
+    command "delete all widgets from storage", :priority=>10
+    def reset
+      @data.delete_all
+      "All widgets destroyed. May they rest in peace."
+    end
+
+    command "return a list of existing widget names", :default
+    def list
+      puts "Widgets:"
+      if @data.length > 0
+        @data.read_all.collect{|widget| " #{widget[:name]}"}
+      else
+        " <none>"
+      end
+    end
+
+    command "destroy an existing widget", :xor
+    def destroy(name)
+      if @data.delete(name)
+        "#{name} destroyed. You heartless bastard!"
+      else
+        "There is no #{name} in storage."
+      end
+    end
+    command "delete an existing widget", :xor
+    alias :delete :destroy 
+    
+    command "spend lots of money to update a widget", :xor
+    def upgrade(name)
+      if @data.update(name) 
+        "You just gave #{name} a fresh coat of paint!"
+      else
+        "There is no #{name} in storage."
+      end
+    end
+
+  end
+end

data/lib/widget.rb

@@ -0,0 +1,7 @@
+# Make sure you load and configure Commandable before loading your
+# application's files or some of the settings won't work properly
+require 'widget/commandable_config'
+
+# Now you can load your app's files
+require 'widget/widget_viewtroller'
+require 'widget/widget_data'

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$:.unshift File.expand_path((File.dirname(__FILE__) + '/../lib'))
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'rspec'
+
+# Allow an instance class to be "reset"
+require 'singleton'
+class <<Singleton
+  def included_with_reset(klass)
+    included_without_reset(klass)
+    class <<klass
+      def reset_instance
+        Singleton.send :__init__, self
+        self
+      end
+    end
+  end
+  alias_method :included_without_reset, :included
+  alias_method :included, :included_with_reset
+end
+
+require 'widget'

data/spec/widget/widget_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'time'
+
+describe Widget::Data do
+
+  before(:each) {
+    file_name = File.expand_path((File.dirname(__FILE__) + '/../../db/hashmodel.dat'))
+    File.delete(file_name) if File.exists?(file_name)
+    @data = Widget::Data.instance
+    Widget::Data.reset_instance
+  }
+  
+  context "when creating a widget" do
+    
+    context "and there isn't a widget with that name" do
+      it {lambda{@data.create("Widgee 5"); @data.reload}.should change{@data.count}.by(1)}
+      it { @data.create("Widgee 5").should be_true }
+
+      context "but there is another widget" do
+        before(:each){@data.create("Widgee 1"); @data.reload }
+        it {@data.create("Widgee 5").should be_true }
+        it {@data.create("Widgee 5"); @data.reload; @data.length.should == 2 }
+      end
+    end
+    
+    context "and there is already a widget with that name" do
+      before(:each){@data.create("Widgee 5")}
+      it "doesn't add a widget" do
+        lambda{@data.create("Widgee 5"); @data.reload}.should_not change{@data.length}
+      end
+    end
+    
+  end
+
+  context "when reading widgets" do
+    
+    it "should read by name" do
+      widgee_whatever = "Widgee #{rand(100)}"
+      @data.create(widgee_whatever)
+      @data.reload
+      @data.read(widgee_whatever).to_s.should match(/#{widgee_whatever}/)
+    end
+    
+    it "should read_all widgets" do
+      4.times { |i| @data.create("Widgee #{i}")}
+      @data.reload
+      4.times { |i| @data.read_all.to_s.should match("Widgee #{i}")}
+    end
+    
+  end
+
+  context "when deleteing widgets" do
+    before(:each) do
+      10.times { |i| @data.create("Widgee #{i}") }
+      @data.reload
+    end
+
+    context "and you clear them all" do
+      it{@data.delete_all; @data.reload; @data.length.should == 0}
+    end
+
+    context 'and you delete one by name' do
+      let(:widgee){"Widgee 0"}
+      it {lambda{@data.delete(widgee); @data.reload}.should change{@data.length}.from(10).to(9)}
+      it {@data.delete(widgee); ;@data.reload; @data.read(widgee).should be_empty}
+    end
+    
+  end
+  
+  context "when upgrading a widget" do
+    before(:each) do
+      3.times { |i| @data.create("Widgee #{i}"); @data.reload }
+    end
+
+    context "and the widget exists" do
+      it {lambda{@data.update("Widgee 1")}.should_not raise_error}
+      it {lambda{@data.update("Widgee 1"); @data.reload}.should change{@data.read("Widgee 1")[0][:modified_at].clone}}
+      it {@data.update("Widgee 1").should be_true}
+    end
+    
+    context "but the widget doesn't exist" do
+      it {lambda{@data.update("Widgee 99")}.should_not raise_error}
+      it {@data.update("Widgee 99").should be_false}
+    end
+    
+  end
+
+end

data/widget.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "widget/version"
+
+Gem::Specification.new do |s|
+  s.name        = "widget"
+  s.version     = Widget::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mike Bethany"]
+  s.email       = ["mikbe.tk@gmail.com"]
+  s.homepage    = "http://mikbe.tk"
+  s.summary     = %q{A demonstration app showing how to use Commandable and HashModle}
+  s.description = %q{A demonstration app showing how to use Commandable and HashModel. It also serves as a test platform for fleshing out problems and designing new features for the aforementioned libraries.}
+  
+  s.add_dependency("hashmodel", "0.4.0.beta2")
+  s.add_dependency("commandable", "0.2.0.beta2")
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: widget
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Bethany
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-03-21 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashmodel
+  requirement: &2156171880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.4.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156171880
+- !ruby/object:Gem::Dependency
+  name: commandable
+  requirement: &2156171180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.2.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156171180
+description: A demonstration app showing how to use Commandable and HashModel. It
+  also serves as a test platform for fleshing out problems and designing new features
+  for the aforementioned libraries.
+email:
+- mikbe.tk@gmail.com
+executables:
+- widget
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENCE.txt
+- README.markdown
+- Rakefile
+- _test/marshal.rb
+- _test/widget.hashmodel
+- autotest/discover.rb
+- bin/widget
+- db/hashmodel.dat
+- features/setup/env.rb
+- features/step-definitions/step-definitions.rb
+- features/support/helpers.rb
+- features/widget_creation.feature
+- features/widget_deletion.feature
+- features/widget_details.feature
+- features/widget_list_names.feature
+- features/widget_upgrade.feature
+- images/salandrichard.jpeg
+- images/salandrichard.jpg
+- lib/.DS_Store
+- lib/widget.rb
+- lib/widget/.DS_Store
+- lib/widget/commandable_config.rb
+- lib/widget/version.rb
+- lib/widget/widget_data.rb
+- lib/widget/widget_viewtroller.rb
+- spec/spec_helper.rb
+- spec/widget/widget_spec.rb
+- widget.gemspec
+has_rdoc: true
+homepage: http://mikbe.tk
+licenses: []
+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.6.2
+signing_key: 
+specification_version: 3
+summary: A demonstration app showing how to use Commandable and HashModle
+test_files:
+- features/setup/env.rb
+- features/step-definitions/step-definitions.rb
+- features/support/helpers.rb
+- features/widget_creation.feature
+- features/widget_deletion.feature
+- features/widget_details.feature
+- features/widget_list_names.feature
+- features/widget_upgrade.feature
+- spec/spec_helper.rb
+- spec/widget/widget_spec.rb