life_game_viewer 0.9.1

data/lib/life_game_viewer/view/actions.rb

@@ -0,0 +1,193 @@
+# Contains Action classes used by the application.
+
+require_relative 'clipboard_helper'
+
+
+# Java Imports:
+java_import %w(
+    javax.swing.AbstractAction
+)
+
+
+# Generation Move Actions.  Class hierarchy is:
+#
+# MoveAction
+# -- ShowPastGenerationAction
+# -- -- ShowFirstGenerationAction
+# -- -- ShowPreviousGenerationAction
+# -- ShowFutureGenerationAction
+# -- -- ShowNextGenerationAction
+# -- -- ShowLastGenerationAction
+
+
+class MoveAction < AbstractAction
+
+  def initialize(table_model)
+    super(caption)  # caption implemented by subclasses
+    @table_model = table_model
+
+    # should_be_enabled? below needs to be implemented by subclasses
+    enabled_updater = lambda do |current_generation_num|
+      self.enabled = should_be_enabled?
+    end
+
+    @table_model.add_current_num_change_handler(enabled_updater)
+
+    self.enabled = enabled_updater.call(nil)
+  end
+
+  def actionPerformed(event)
+    move  # implemented by subclasses
+    @table_model.fire_table_data_changed
+  end
+end
+
+
+
+
+class ShowPastGenerationAction < MoveAction
+
+  def initialize(table_model)
+    super(table_model)  # caption implemented by subclasses
+  end
+
+  def should_be_enabled?
+    ! @table_model.at_first_generation?
+  end
+end
+
+
+
+
+class ShowFirstGenerationAction < ShowPastGenerationAction
+
+  def initialize(table_model)
+    super(table_model)
+  end
+
+  def move
+    @table_model.go_to_first_generation
+  end
+
+  def caption
+    "First (1)"
+  end
+end
+
+
+
+
+class ShowPreviousGenerationAction < ShowPastGenerationAction
+
+  def initialize(table_model)
+    super(table_model)
+  end
+
+  def move
+    @table_model.go_to_previous_generation
+  end
+
+  def caption
+    "Previous (4)"
+  end
+end
+
+
+
+
+class ShowFutureGenerationAction < MoveAction
+
+  def initialize(table_model)
+    super(table_model)  # caption implemented by subclasses
+  end
+
+  def should_be_enabled?
+    ! @table_model.at_last_generation?
+  end
+end
+
+
+
+
+class ShowNextGenerationAction < ShowFutureGenerationAction
+
+  def initialize(table_model)
+    super(table_model)
+  end
+
+  def move
+    @table_model.go_to_next_generation
+  end
+
+  def caption
+    "Next (7)"
+  end
+end
+
+
+
+
+class ShowLastGenerationAction < ShowFutureGenerationAction
+
+  def initialize(table_model)
+    super(table_model)
+  end
+
+  def move
+    @table_model.go_to_last_generation
+  end
+
+  def caption
+    "Last (0)"
+  end
+end
+
+
+
+
+class ExitAction < AbstractAction
+
+  # table_model param not used but needed for instantiation by create_button
+  def initialize(table_model)
+    super("Exit (Q)")
+    put_value(SHORT_DESCRIPTION, 'Press capital-Q to exit.')
+  end
+
+  def actionPerformed(event)
+    java.lang.System.exit(0)
+  end
+end
+
+
+
+
+class CopyToClipboardAction < AbstractAction
+
+  def initialize(table_model)
+    super("Copy (C)")
+    put_value(SHORT_DESCRIPTION, "Press #{ClipboardHelper.key_prefix}-C to copy board contents to clipboard.")
+    @table_model = table_model
+  end
+
+  def actionPerformed(event)
+    text = LifeVisualizer.new.to_display_string(@table_model.life_model)
+    ClipboardHelper.clipboard_text = text
+  end
+end
+
+
+
+
+class NewGameFromClipboardAction < AbstractAction
+
+  def initialize(table_model)
+    super("Paste (V)")
+    put_value(SHORT_DESCRIPTION, "Press #{ClipboardHelper.key_prefix}-V to create a new game from the clipboard contents.")
+    @table_model = table_model
+  end
+
+  def actionPerformed(event)
+    new_model = @table_model.life_model.class.send(:create_from_string, ClipboardHelper.clipboard_text)
+    @table_model.reset_model(new_model)
+  end
+end

data/lib/life_game_viewer/view/clipboard_helper.rb

@@ -0,0 +1,55 @@
+java_import 'java.awt.datatransfer.StringSelection'
+java_import 'java.awt.datatransfer.DataFlavor'
+java_import 'java.awt.datatransfer.ClipboardOwner'
+java_import 'java.awt.Toolkit'
+
+
+# Simplifies the use of the system clipboard access via Java.
+class ClipboardHelper
+
+  include ClipboardOwner
+
+  def self.clipboard
+    Toolkit.default_toolkit.system_clipboard
+  end
+
+  def self.clipboard_text
+    transferable = clipboard.getContents(self)
+    transferable.getTransferData(DataFlavor::stringFlavor)
+  end
+
+  def self.clipboard_text=(text)
+    string_selection = StringSelection.new(text)
+    clipboard.setContents(string_selection, self)
+  end
+
+  def self.mac_os?
+    /^Mac/ === java.lang.System.properties['os.name']
+  end
+
+  # For getting descriptive text for, e.g. tooltips.
+  def self.key_prefix
+    mac_os? ? "Command" : "Ctrl"
+  end
+
+  # Gets the first Action object associated with the passed action_name.
+  def self.input_action_key(action_name)
+    map = UIManager.get("TextField.focusInputMap")
+    map.keys.select { |key| map.get(key) == action_name }.first
+  end
+
+  # Name of copy key for this OS.
+  def self.copy_key_name
+    input_action_key("copy-to-clipboard").to_string
+  end
+
+  # Name of paste key for this OS.
+  def self.paste_key_name
+    input_action_key("paste-from-clipboard").to_string
+  end
+
+  def self.lostOwnership(clipboard, contents)
+    # do nothing; this method called by Java when this object loses ownership
+    # of the clipboard.
+  end
+end

data/lib/life_game_viewer/view/generations.rb

@@ -0,0 +1,67 @@
+class Generations < Array
+
+  attr_reader :last_num
+  attr_accessor :current_num
+
+  def initialize(life_model)
+    self << life_model
+    @current_num = 0
+    @last_num = nil
+    ensure_next_in_cache
+  end
+
+  def current
+    self[current_num]
+  end
+
+  def found_last_generation?
+    !!@last_num
+  end
+
+  def at_last_generation?
+    current_num == @last_num
+  end
+
+  def at_first_generation?
+    current_num == 0
+  end
+
+  def ensure_next_in_cache
+    at_end_of_array = (current_num == (size - 1))
+    need_to_get_new_model = at_end_of_array && (! found_last_generation?)
+    if need_to_get_new_model
+      tentative_next = current.next_generation_model
+      if tentative_next == current
+        @last_num = current_num
+      else
+        self << tentative_next
+      end
+
+    end
+  end
+
+  def next
+    raise "Next was called when at end of lineage." if at_last_generation?
+    self.current_num = current_num + 1
+    ensure_next_in_cache
+    current
+  end
+
+  def previous
+    raise "Previous was called when at first generation." if at_first_generation?
+    self.current_num = current_num - 1
+    current
+  end
+
+  def first
+    self.current_num = 0
+    current
+  end
+
+  def last
+    until at_last_generation?
+      self.next
+    end
+    current
+  end
+end

data/lib/life_game_viewer/view/life_game_viewer_frame.rb

@@ -0,0 +1,293 @@
+# This file contains the definitions of all the Swing UI component
+# classes.  The one containing all the rest is the MainFrame class.
+
+require 'java'
+
+require_relative '../model/life_visualizer'
+require_relative '../model/model_validation'
+require_relative '../model/sample_life_model'
+require_relative 'life_table_model'
+require_relative 'actions'
+
+
+# Java Imports:
+java_import %w(
+    java.awt.BorderLayout
+    java.awt.Color
+    java.awt.Desktop
+    java.awt.Dimension
+    java.awt.Frame
+    java.awt.GridLayout
+    java.awt.Toolkit
+    java.awt.event.KeyEvent
+    java.awt.event.MouseAdapter
+    java.awt.event.WindowAdapter
+    java.net.URI
+    javax.swing.BorderFactory
+    javax.swing.Box
+    javax.swing.ImageIcon
+    javax.swing.JButton
+    javax.swing.JComponent
+    javax.swing.JFrame
+    javax.swing.JLabel
+    javax.swing.JPanel
+    javax.swing.JScrollPane
+    javax.swing.JTable
+    javax.swing.KeyStroke
+    javax.swing.UIManager
+    javax.swing.table.TableCellRenderer
+)
+
+
+class LifeGameViewerFrame < JFrame
+
+  attr_accessor :table_model
+
+  # Special class method for demonstration purposes; makes it
+  # trivially simple to view the program in action without
+  # having to add any custom behavior.
+  def self.view_sample
+    str = ''
+    12.times { str << ('*-' * 6) << "\n" }
+    model = SampleLifeModel.create_from_string(str)
+    frame = LifeGameViewerFrame.new(model)
+    frame.visible = true
+    frame  # return frame so it can be manipulated (.visible =, etc.)
+  end
+
+  def initialize(life_model)
+    model_validation_message = ModelValidation.new.methods_missing_message(life_model)
+    if model_validation_message
+      raise model_validation_message
+    end
+
+    super('The Game of Life')
+    @table_model = LifeTableModel.new(life_model)
+    self.default_close_operation = JFrame::EXIT_ON_CLOSE
+    add(JScrollPane.new(Table.new(table_model)), BorderLayout::CENTER)
+    add(HeaderPanel.new, BorderLayout::NORTH)
+    add(BottomPanel.new(@table_model, self), BorderLayout::SOUTH)
+    content_pane.border = BorderFactory.create_empty_border(12, 12, 12, 12)
+    pack
+  end
+
+  # This is the method that Swing will call to ask what size to
+  # attempt to set for this window.
+  def getPreferredSize
+    # use the default size calculation; this would of course also be accomplished
+    # by not implementing the method at all.
+    super
+
+    # Or, you can override it with specific pixel sizes (width, height)
+    # Dimension.new(700, 560)
+
+    # Or, use the line below to make it the full screen size:
+    # Toolkit.get_default_toolkit.screen_size
+  end
+end
+
+
+
+# The application's table, containing alive/dead board values.
+class Table < JTable
+  def initialize(table_model)
+    super(table_model)
+    self.table_header = nil
+    self.show_grid = true
+    self.grid_color = Color::BLUE
+    set_default_renderer(java.lang.Object, CellRenderer.new)
+    self.row_height = 32
+  end
+end
+
+
+
+# Combines button panel and bottom text panel into a single panel.
+class BottomPanel < JPanel
+  def initialize(table_model, ancestor_window)
+    layout = GridLayout.new(0, 1)
+    super(layout)
+    layout.vgap = 12
+    add(ButtonPanel.new(table_model, ancestor_window))
+    add(StatusAndLinksPanel.new(table_model))
+  end
+end
+
+
+# Panel for top of main application window containing a large title.
+class HeaderPanel < JPanel
+  def initialize
+    super(BorderLayout.new)
+    label = JLabel.new("<html><h2>Conway's Game of Life Viewer</h2></html")
+    inner_panel = JPanel.new
+    inner_panel.add(label)
+    add(inner_panel, BorderLayout::CENTER)
+  end
+end
+
+
+# Subclassed by application buttons, contains their common functionality
+# added to the Swing JButton class.
+class Button < JButton
+  def initialize(action_class, keystroke_text, table_model)
+    action = action_class.send(:new, table_model)
+    super(action)
+    key = KeyStroke.getKeyStroke(keystroke_text)
+    get_input_map(JComponent::WHEN_IN_FOCUSED_WINDOW).put(key, keystroke_text)
+    get_action_map.put(keystroke_text, action)
+  end
+end
+
+
+# Panel containing horizontal row of buttons.
+class ButtonPanel < JPanel
+  def initialize(table_model, ancestor_window)
+    super(GridLayout.new(1, 0))
+    add(Button.new(ShowFirstGenerationAction, KeyEvent::VK_1, table_model))
+    add(Button.new(ShowPreviousGenerationAction, KeyEvent::VK_4, table_model))
+
+    next_button = Button.new(ShowNextGenerationAction, KeyEvent::VK_7, table_model)
+    add(next_button)
+    ancestor_window.add_window_listener(InitialFocusSettingWindowListener.new(next_button))
+
+    add(Button.new(ShowLastGenerationAction,     KeyEvent::VK_0, table_model))
+    add(Button.new(CopyToClipboardAction,        ClipboardHelper.copy_key_name, table_model))
+    add(Button.new(NewGameFromClipboardAction,   ClipboardHelper.paste_key_name, table_model))
+    add(Button.new(ExitAction,                   KeyEvent::VK_Q, table_model))
+  end
+end
+
+
+
+# Status label showing, e.g. "Current Generation: 1, Population: 42"
+class StatusLabel < JLabel
+  def initialize(table_model)
+    super()
+    @update_text = lambda do |current_generation_num|
+      last_fragment = table_model.at_last_generation? ? " (last)" : ""
+      self.text = "Current Generation#{last_fragment}: #{current_generation_num}, Population: #{table_model.number_living}"
+    end
+    @update_text.call(0)
+    self.horizontal_alignment = JLabel::CENTER
+    table_model.add_current_num_change_handler(@update_text)
+  end
+end
+
+
+# This class is responsible for rendering the display of a table cell,
+# which in our case is to display an image of Alfred E. Neuman if the
+# underlying data value is true, else display nothing.
+class CellRenderer
+
+  class LifeLabel < JLabel
+    def initialize
+      super
+      self.horizontal_alignment = JLabel::CENTER
+      self.vertical_alignment = JLabel::CENTER
+      self.opaque = true
+    end
+  end
+
+  def initialize
+    @label = LifeLabel.new
+    image_spec = File.expand_path(File.join(
+        File.dirname(__FILE__), '..', '..', '..', 'resources', 'images', 'alfred-e-neuman.jpg'))
+    @true_icon = ImageIcon.new(image_spec, 'Alfred E. Neuman')
+  end
+
+  # from TableCellRenderer interface
+  def getTableCellRendererComponent(table, value, is_selected, has_focus, row, column)
+    alive = value
+    @label.icon = alive ? @true_icon : nil
+    @label.tool_tip_text = "row #{row}, column #{column}, value is #{alive}"
+    @label
+  end
+end
+
+
+# When added as a listener to a given window, will cause the
+# passed component to own focus when the window first opens.
+class InitialFocusSettingWindowListener < WindowAdapter
+
+  def initialize(component_requesting_focus)
+    super()
+    @component_requesting_focus = component_requesting_focus
+  end
+
+  def windowOpened(event)
+    @component_requesting_focus.requestFocus
+  end
+end
+
+
+
+# JLabel that a) provides a clickable link that launches the default browser
+# with the passed URL, b) makes the text appear like a hyperlink, and
+# c) sets the tooltip text to be the URL.
+class HyperlinkLabel < JLabel
+
+  def initialize(url, caption, tool_tip_text)
+    text = "<html><a href=#{url}>#{caption}</a></html>"  # make it appear like a hyperlink
+    super(text)
+    self.tool_tip_text = tool_tip_text
+    add_mouse_listener(ClickAdapter.new(url))
+  end
+
+  class ClickAdapter < MouseAdapter
+
+    def initialize(url)
+      super()
+      @url = url
+    end
+
+    def mouseClicked(event)
+      Desktop.desktop.browse(URI.new(@url))
+    end
+  end
+end
+
+
+class LinkPanel < JPanel
+
+  def initialize
+
+    #Without the call to super below, I get the following error:
+    #RuntimeError: Java wrapper with no contents: LinkPanel
+    #see http://jira.codehaus.org/browse/JRUBY-4704; not fixed?
+    super
+
+    add(wikipedia_label)
+    add(JLabel.new(" | "))
+    add(github_label)
+    add(JLabel.new(" | "))
+    add(article_label)
+  end
+
+  def wikipedia_label
+    url = 'http://en.wikipedia.org/wiki/Conway%27s_Game_of_Life'
+    HyperlinkLabel.new(url, "Wikipedia",
+        "Visit Conway's Game of Life page on Wikipedia at #{url}.")
+  end
+
+  def github_label
+    url = 'http://github.com/keithrbennett/life-game-viewer'
+    HyperlinkLabel.new(url, "Github",
+        "Visit the Github page for this project at #{url}.")
+  end
+
+  def article_label
+    url = 'http://www.bbs-software.com/blog/2012/09/05/conways-game-of-life-viewer/'
+    HyperlinkLabel.new(url, "Article",
+        "Visit the blog article about this project at #{url}.")
+  end
+end
+
+
+
+class StatusAndLinksPanel < JPanel
+  def initialize(table_model)
+    super(BorderLayout.new)
+    add(StatusLabel.new(table_model), BorderLayout::WEST)
+    add(LinkPanel.new, BorderLayout::EAST)
+  end
+end

data/lib/life_game_viewer/view/life_table_model.rb

@@ -0,0 +1,97 @@
+require 'java'
+
+java_import javax.swing.table.AbstractTableModel
+java_import javax.swing.JOptionPane
+
+require_relative 'generations'
+
+# This class is the model used to drive Swing's JTable.
+# It contains a LifeModel to which it delegates most calls.
+class LifeTableModel < AbstractTableModel
+
+  attr_accessor :life_model
+  attr_reader :generations
+
+
+  def initialize(life_model)
+    super()
+    @current_num_change_handlers = []
+    self.inner_model = life_model
+  end
+
+  def inner_model=(life_model)
+    @life_model = life_model
+    @generations = Generations.new(life_model)
+  end
+
+  def getRowCount
+    life_model.row_count
+  end
+
+  def getColumnCount
+    life_model.column_count
+  end
+
+  def getValueAt(row, col)
+    life_model.alive?(row, col)
+  end
+
+  def getColumnName(colnum)
+    nil
+  end
+
+  def at_first_generation?
+    generations.at_first_generation?
+  end
+
+  def at_last_generation?
+    generations.at_last_generation?
+  end
+
+  def number_living
+    life_model.number_living
+  end
+
+  def go_to_next_generation
+    if at_last_generation?
+      JOptionPane.show_message_dialog(nil, "Generation ##{generations.current_num} is the last non-repeating generation.")
+    else
+      self.life_model = generations.next
+      fire_current_number_changed
+    end
+  end
+
+  def go_to_previous_generation
+    raise "Should not have gotten here; already at first generation" if at_first_generation?
+    self.life_model = generations.previous
+    fire_current_number_changed
+  end
+
+  def go_to_first_generation
+    self.life_model = generations.first
+    fire_current_number_changed
+  end
+
+  def go_to_last_generation
+    self.life_model = generations.last
+    fire_current_number_changed
+  end
+
+  def add_current_num_change_handler(callable)
+    @current_num_change_handlers << callable
+  end
+
+  def reset_model(new_model)
+    self.inner_model = new_model
+    fire_table_structure_changed
+    fire_current_number_changed
+  end
+
+  def fire_current_number_changed
+    @current_num_change_handlers.each do |handler|
+      handler.call(generations.current_num)
+    end
+  end
+end
+
+

data/lib/life_game_viewer/view/main.rb

@@ -0,0 +1,16 @@
+
+# Main entry point into the application.
+module LifeGameViewer
+  class Main
+
+
+    def self.view_sample
+      LifeGameViewerFrame.view_sample
+    end
+
+    def self.view(model)
+      LifeGameViewerFrame.new(model).visible = true
+    end
+
+  end
+end