cura 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dc4976329742a1e8bc47cc375e5ff89ef1497b7
-  data.tar.gz: 0c8446f8d98820d0da375ba4e34e339a5c6b9a72
+  metadata.gz: 58ffd768a7cabdd176ee4d6063ce373aa1fb47a8
+  data.tar.gz: 8afa76729e3f1b62abc326be6a371905760caaa8
 SHA512:
-  metadata.gz: ae30d4bb7ace9f7aa1691a2f2bf50977a6c83ea1d7d4e4b14c60a202abd7a8518bab8ef3c10aba4244943c82b4c8f2155c5eeab46458a67e91c50fa27ec5a362
-  data.tar.gz: b3916599cb6e07dfa49a0829c524b4553def25e987d9249b84180b18bcc8cc43f578436d91fff0d7f2544a569d9d8a9084fceb1b95513a62ac378ad7d659860e
+  metadata.gz: ca3650bc0c20a6fd526a44ed4f1e89cadcbe5f21e30889078eaa1d0ffcfad999791e91629041bd90d217905182c03bea1ec4f7cce6fb2704807ca1a086105dd0
+  data.tar.gz: 8538379553f3090dad61c27d2f99569260106547d793a070ea48a3ee4b1a16bc61cc752f347bfc90e49ce3ef3859fa26031f3d917e35be5de1f9969fc2e3ff3e

data/README.md

@@ -1,19 +1,45 @@
 # Cura
 
-A component toolkit for creating both graphical and text-based user interfaces.
+A component toolkit for creating user interfaces.
+
+Cura can be used to create:
+
+* Command-line interfaces (`CLI`).
+* Text-based user interfaces (`TUI`).
+* Graphical user interfaces (`GUI`).
+* Read-Eval-Print-Loops (`REPL`).
+* Extensions or functionality in current applications.
+
+Cura is:
+
+* Portable
+* * No dependencies on external libraries or gems, besides adapters.
+* * Does not use any IO or system-specific methods.
+* * Can be used on any Ruby implementation, including MRuby (embeddable).
+* Adaptable
+* * Adapters exist for implementation and platform specific windowing, drawing, and terminal printing libraries.
+* * Easily create adapters for any external library to implement a custom view tree for any application.
 
 Cura provides:
 
+* <s>Command system</s>
+* * <s>Simple routing DSL.</s>
+* * <s>Class based commands.</s>
+* * <s>Windows and \*NIX style option parsing (optional, for use outside of CLI environments).</s>
+* * <s>Usable in CLI, TUI, GUI, REPL, or any environment.</s>
 * Component system
-* * Tree hierarchy
-* * Box model layouts
+* * [View tree][view_tree] hierarchy.
+* * Box model layouts.
+* * <s>CCML, a XML user interface markup language for defining view trees</s>
 * Event system
-* * Dispatching
-* * Middleware (aiming & translating)
-* * Handling
-* * Delegation
+* * Dispatch event loop.
+* * Middleware for modifying or translating events.
+* * Defining events on any Ruby object.
+* * Propagation using both the capturing and the bubbling models and ability to stop propagation.
 * Adapter system
 
+> Note: <s>Strikethrough</s> means not yet implemented (wait for 0.1.0)
+
 ## Install
 
 ### Bundler: `gem 'cura'`
@@ -29,7 +55,6 @@ Used for its libraries.
 **Text-based User Interface (TUI)**
 
 * [Termbox][ruby-termbox]
-* [Termbox FFI][ruby-termbox-ffi]
 * [Curses][ruby-curses]
 
 **Graphical User Interface (GUI)**
@@ -67,18 +92,16 @@ Ruby FFI based adapters should also work in JRuby.
 
 ## Usage
 
-> **NOTE:** The following is not functional yet. Move along...
-
 ```rb
 require 'cura'
 
 # Define our window
 
 class MainWindow < Cura::Window
-  
+
   def initialize
     super
-    
+
     @label = Cura::Label.new(
       text: 'Hello, world!',
       bold: true,
@@ -88,26 +111,26 @@ class MainWindow < Cura::Window
       border: { size: 1, color: Cura::Color.red },
       padding: 3
     )
-    
+
     add_child( @label ) # Will mixin any adapter methods for Label
   end
-  
+
 end
 
 # Define our application and add our window
 
 class Application < Cura::Application
-  
+
   def initialize
     super
-    
+
     @window = MainWindow.new
-    
+
     add_window( @window )
-    
+
     @window.show # Note that in TUIs, only one window can be shown at once.
   end
-  
+
 end
 
 # Require any adapters
@@ -127,9 +150,9 @@ adapter_names = Cura::Adapter.all.collect(&:name)
 adapter = loop do
   puts "Choose one or type 'exit': #{ adapter_names.join(', ') }"
   print '> '
-  
+
   answer = gets.downcase.strip
-  
+
   exit if answer == 'exit'
   retry unless adapter_names.include?( answer.to_sym )
 end
@@ -145,6 +168,7 @@ Copyright © 2015 Ryan Scott Lewis <ryan@rynet.us>.
 
 The MIT License (MIT) - See LICENSE for further details.
 
+[view_tree]: http://www.mit.edu/~6.005/fa14/classes/22-graphical-user-interfaces/
 [ruby-termbox]: https://github.com/RyanScottLewis/ruby-cura-adapter-termbox
 [ruby-termbox-ffi]: https://github.com/RyanScottLewis/ruby-cura-adapter-termbox-ffi
 [ruby-curses]: https://github.com/RyanScottLewis/ruby-cura-adapter-curses

data/cura.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.version = Cura::VERSION
 
   # Dependencies
-  s.add_development_dependency "builder", "~> 3.2.2" # TODO: What? Is this needed?
+  s.add_development_dependency "builder", "~> 3.2.2" # TODO: Needed? Reallllyyy?
 
   # Pragmatically set variables
   s.homepage      = "http://github.com/RyanScottLewis/#{s.name}"

data/examples/hello_world/lib/hello_world.rb

@@ -48,7 +48,7 @@ class HelloWorld < Cura::Application
   #   end
   #
   # end
-  
+
   on_event(:key_down) do |event|
     stop if event.control? && event.name == :C # CTRL+C
   end
@@ -61,10 +61,10 @@ class HelloWorld < Cura::Application
   attr_reader :form_zip_textbox
   attr_reader :form_submit_button
   attr_reader :people_listbox
-  
+
   def initialize(attributes={})
     super
-    
+
     @dispatcher.wait_time = 100 # Update every 100 milliseconds instead of waiting forever for events
 
     window = Cura::Window.new
@@ -72,7 +72,7 @@ class HelloWorld < Cura::Application
 
     pack = Cura::Component::Pack.new(width: window.width, height: window.height, fill: true)
     window.add_child(pack)
-    
+
     label_header = Cura::Component::Label.new(text: "Cura", bold: true, underline: true, alignment: { horizontal: :center }, margin: { top: 1 })
     pack.add_child(label_header)
 
@@ -155,13 +155,13 @@ class HelloWorld < Cura::Application
       zip   = application.form_zip_textbox.text
 
       application.clear_form
-      
+
       label_text_segments = []
       label_text_segments << "First: #{first}" unless first.empty?
       label_text_segments << "Last: #{last}" unless last.empty?
       label_text_segments << "Age: #{age}" unless age.empty?
       label_text_segments << "ZIP: #{zip}" unless zip.empty?
-      
+
       label = Cura::Component::Label.new(text: label_text_segments.join(" - "))
       application.people_listbox.add_child(label)
     end
@@ -169,13 +169,13 @@ class HelloWorld < Cura::Application
 
     people_label = Cura::Component::Label.new(text: "People:")
     pack.add_child(people_label)
-    
+
     @people_listbox = Cura::Component::Listbox.new
     @people_listbox.on_event(:key_down) { |event| delete_child(selected_child) if event.control? && event.name == :D }
 
     pack.add_child(@people_listbox)
-    
-    
+
+
 
     input_textbox.focus
   end
@@ -197,5 +197,5 @@ class HelloWorld < Cura::Application
 
     @form_first_name_textbox.focus
   end
-  
+
 end

data/examples/mruby-examples/mrbgem.rake

@@ -1,14 +1,13 @@
 MRuby::Gem::Specification.new('cura-examples') do |spec|
-  
+
   spec.license = 'MIT'
   spec.author  = 'Ryan Scott Lewis'
   spec.summary = ''
-  
+
   spec.rbfiles = []
-  
-  # HelloWorld
+
   spec.rbfiles << "#{dir}/../hello_world/lib/hello_world.rb"
-  
+
   spec.bins << "hello_world"
-  
+
 end

data/examples/todo_list/lib/todo_list/application.rb

@@ -1,3 +1,5 @@
+require "pry"
+
 require "cura"
 
 require "todo_list/component/header"
@@ -5,50 +7,54 @@ require "todo_list/component/lists"
 require "todo_list/component/list_items"
 
 module TodoList
-  
+
   class Application < Cura::Application
-    
+
     on_event(:key_down) do |event|
       stop if event.control? && event.name == :C # CTRL+C
     end
-    
+
     attr_reader :list_items
-    
+
     def initialize(attributes={})
       super
-      
+
       window = Cura::Window.new
-      
+
       add_window(window)
-      
+
       window.on_event(:key_down) do |event|
         @focus_controller.index += 1 if event.control? && event.name == :F
         @focus_controller.index -= 1 if event.control? && event.name == :B
+        if event.control? && event.name == :P
+          application.stop!
+          pry
+        end
       end
-      
+
       #-
-      
+
       window.root = Cura::Component::Pack.new(width: window.width, height: window.height, fill: true)
-      
+
       header = Component::Header.new
       window.add_child(header)
-      
+
       middle_pack = Cura::Component::Pack.new(height: window.height - 1, orientation: :horizontal, fill: true)
       window.add_child(middle_pack)
-      
+
       sidebar = Component::Lists.new(width: 30, padding: 1)
       middle_pack.add_child(sidebar)
-      
+
       @list_items = Component::ListItems.new(width: window.width - 30 - 4, padding: 1)
       middle_pack.add_child(@list_items) # , expand: true, fill: true) # TODO
-      
+
       #-
-      
+
       @list_items.list = sidebar.listbox.selected_object if sidebar.listbox.children?
-      
+
       sidebar.create_list_textbox.focus
     end
-  
+
   end
-  
+
 end

data/lib/cura/adapter.rb

@@ -4,64 +4,57 @@ if Kernel.respond_to?(:require)
 end
 
 module Cura
-  
   # The base class for adapters.
   class Adapter
-    
     class << self
-      
       # The list of all Adapter subclasses.
       #
       # @return [Array]
       def all
         @all ||= []
       end
-      
+
       def inherited(subclass)
         all << subclass
       end
-      
+
       def mixins
         @mixins ||= {}
       end
-      
+
       def mixin(value)
         mixins.merge!(value.to_h)
       end
-      
     end
-    
+
     include Attributes::HasInitialize
     include Attributes::HasAttributes
-    
+
     def initialize(attributes={})
       @setup = false
-      
+
       super
     end
-    
+
     def setup
       @setup = true
-      
+
       self.class.mixins.each { |type, mod| type.send(:include, mod) }
-      
+
       self
     end
-    
+
     def setup?
       @setup
     end
-    
+
     def clear
-      
     end
-    
+
     def cleanup
       @setup = false
-      
+
       self
     end
-    
   end
-  
 end

data/lib/cura/application.rb

@@ -3,11 +3,11 @@ if Kernel.respond_to?(:require)
   require "cura/attributes/has_windows"
   require "cura/attributes/has_events"
   require "cura/attributes/has_initialize"
-  
+
   require "cura/component/base"
-  
+
   require "cura/event/dispatcher"
-  
+
   require "cura/event/click"
   require "cura/event/focus"
   require "cura/event/unfocus"
@@ -18,121 +18,119 @@ if Kernel.respond_to?(:require)
   require "cura/event/mouse_wheel_up"
   require "cura/event/resize"
   require "cura/event/selected"
-  
+
   require "cura/event/middleware/dispatch"
   require "cura/event/middleware/aimer/mouse_focus"
   require "cura/event/middleware/aimer/target_option"
   require "cura/event/middleware/aimer/dispatcher_target"
   require "cura/event/middleware/translator/mouse_click"
-  
+
   require "cura/error/invalid_adapter"
-    
+
   require "cura/cursor"
   require "cura/pencil"
 end
 
 module Cura
-  
   # An application.
   class Application
-    
     class << self
-      
       def run(attributes={})
         new(attributes).run
       end
-      
     end
-    
+
     include Attributes::HasInitialize
     include Attributes::HasAttributes
     include Attributes::HasWindows
     include Attributes::HasEvents
-    
+
     def initialize(attributes={})
       super
-      
+
+      # setup_adapter
+
       @running = false
       @cursor = Cursor.new(application: self)
       @pencil = Pencil.new
-      
+
       setup_adapter
       setup_dispatcher
     end
-    
+
     # @method adapter
     # Get the adapter used for running this application.
     #
     # @return [Adapter]
-    
+
     # @method adapter=(adapter)
     # Set the adapter used for running this application.
     # This cannot be set after #run is used.
     #
     # @param [Adapter] value The new adapter.
     # @return [Adapter]
-    
+
     attribute(:adapter) { |adapter| validate_adapter(adapter) }
-    
+
     # Get the text cursor.
     #
     # @return [Cursor]
     attr_reader :cursor
-    
+
     # Get the pencil used for drawing.
     #
     # @return [Pencil]
     attr_reader :pencil
-    
+
     # Get the event dispatcher.
     #
     # @return [Event::Dispatcher]
     attr_reader :dispatcher
-    
+
     # Run this application.
     #
     # @return [Application] This application.
     def run
       run_event_loop
-      
+
       self
     ensure
       @adapter.cleanup
     end
-    
+
     # Stop the application after the current run cycle.
     #
     # @return [Application] This application.
     def stop
       @running = false
-      
+
       self
     end
-    
+
     # Stop the application immediently.
     #
     # @return [Application] This application.
     def stop!
       stop
       @adapter.cleanup
-      
+
       self
     end
-    
+
     # Check if this application is running.
     #
     # @return [Boolean]
     def running?
       @running
     end
-    
+
     # Get the currently focused component.
     #
     # @return [Component::Base]
     def focused
       @dispatcher.target
     end
-    
+
     # Set focus to a component.
     #
     # There can only be one component focused at a time within an application, if any.
@@ -142,14 +140,14 @@ module Cura
     # @return [Component::Base]
     def focus(component)
       raise TypeError, "component must be nil or be a Cura::Component::Base" unless component.nil? || component.is_a?(Cura::Component::Base)
-      
+
       dispatch_event(:unfocus)
       @dispatcher.target = component
       dispatch_event(:focus)
-      
+
       component
     end
-    
+
     # Dispatch an event.
     #
     # @param [#to_sym] event The name of the event class to create an instance of or an event instance.
@@ -159,16 +157,16 @@ module Cura
     def dispatch_event(event, options={})
       @dispatcher.dispatch_event(event, options)
     end
-    
+
     # Add a window to this application.
     #
     # @param [Window] window
     # @return [Window]
     def add_window(window)
       super
-      
+
       window.application = self
-      
+
       window
     end
 
@@ -178,19 +176,19 @@ module Cura
     def update
       update_windows
       cursor.update
-      
+
       self
     end
-    
+
     # Draw all windows.
     #
     # @return [Application]
     def draw
       draw_windows
-      
+
       self
     end
-    
+
     # Instance inspection.
     #
     # @return [String]
@@ -199,47 +197,45 @@ module Cura
     end
 
     protected
-    
+
     def setup_adapter
       if @adapter.nil?
         adapter_class ||= Adapter.all.first
         raise Error::InvalidAdapter if adapter_class.nil?
-        
+
         @adapter = adapter_class.new
       end
-      
+
       # TODO: If a class is given, run .new on it first
-      
+
       @adapter.setup
     end
-    
+
     def setup_dispatcher
       @dispatcher = Event::Dispatcher.new(application: self)
-      
+
       @dispatcher.middleware << Event::Middleware::Aimer::MouseFocus.new
       @dispatcher.middleware << Event::Middleware::Aimer::TargetOption.new
       @dispatcher.middleware << Event::Middleware::Aimer::DispatcherTarget.new
       @dispatcher.middleware << Event::Middleware::Dispatch.new
       @dispatcher.middleware << Event::Middleware::Translator::MouseClick.new
     end
-    
+
     def validate_adapter(adapter)
       # TODO: Raise error if ever set more than once
       raise Error::InvalidAdapter unless adapter.is_a?(Cura::Adapter)
-      
+
       adapter
     end
-    
+
     def run_event_loop
       @running = true
-      
+
       while @running
         update
         draw
         dispatcher.run
       end
     end
-    
   end
-  
 end