glimmer-cs-calculator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1181ebd61993301957b214666f187c7ecf1be2aea7bb288aa6abb67ddc664225
+  data.tar.gz: 170e6809beb9a4b6dca428a8cd83f9772d496e54ab1a8a92a15982704ffcfa14
+SHA512:
+  metadata.gz: 38d88bed477197cfd91b52eeac642ae31ccecdcf56df7324f1e6bbd009c15db28038486df02921ddbdcb36cf0f3858799b09dee26691c601995283e5a131c7f8
+  data.tar.gz: 7680cbdd1555d5db2e55a2724807ad7812ca943a879bd873115150bf342d4e5d88b0845ac5dbf8ff4ac2e1d2273bc777336b0e12322c6143da73b8a207ae5aac

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Andy Maleh
+
+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.md

@@ -0,0 +1,70 @@
+# <img alt="Glimmer Calculator Icon" src="glimmer-cs-calculator-icon.png" width="60" /> Calculator - Glimmer Custom Shell
+[![Gem Version](https://badge.fury.io/rb/glimmer-cs-calculator.svg)](http://badge.fury.io/rb/glimmer-cs-calculator)
+
+![Calculator](glimmer-cs-calculator-screenshot.png)
+
+Calculator sample desktop GUI application built with [Glimmer](https://github.com/AndyObtiva/glimmer) (Ruby Desktop Development Library).
+
+It is developed test-first following TDD (Test Driven Development). 
+Design Patterns discovered in the process were Presenter/Facade and Command Pattern.
+
+Follows the MVP architectural pattern (Model View Presenter) thanks to [Glimmer data-binding](https://github.com/AndyObtiva/glimmer#data-binding) support.
+
+## Platforms
+
+- Mac: Tested and [packaged](https://github.com/AndyObtiva/glimmer#packaging--distribution) for the Mac. ([Download Here<img alt="Glimmer Calculator Icon" src="glimmer-cs-calculator-icon.png" width="30" />](https://www.dropbox.com/s/tdgwt2vfxfh13ro/Glimmer%20Calculator-1.0.0.dmg?dl=1))
+- Linux: Not tested/packaged for Linux, but should work by following setup instructions below.
+- Windows: Not tested/packaged for Windows, but should work by following setup instructions below.
+
+## Development Environment Pre-requisites
+
+- JRuby 9.2.11.1 (supporting Ruby 2.5.x syntax) (find at https://www.jruby.org/download)
+- Java SE Runtime Environment 7 or higher (find at https://www.oracle.com/java/technologies/javase-downloads.html)
+
+## Setup Instructions
+
+Install Calculator gem by running (`jgem`, `jruby -S gem`, or `gem` directly if you have RVM):
+
+```
+jgem install glimmer-cs-calculator
+```
+
+Afterwards, you may run `calculator` to bring up the calculator:
+
+```
+calculator
+```
+
+Note: If you cloned this project and bundle installed, you may invoke via `bin/calculator` instead. 
+
+### Glimmer Custom Shell Reuse
+
+To reuse Calculator as a Glimmer Custom Shell inside another Glimmer application, add the 
+following to the application's `Gemfile`:
+
+```
+gem 'glimmer-cs-calculator', '1.0.0'
+```
+
+Run:
+
+```
+jruby -S bundle
+```
+
+And, then instantiate the Calculator custom shell in your Glimmer application via the `calculator` Glimmer DSL keyword.
+
+## Contributing to glimmer-cs-calculator
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2020 Andy Maleh. See LICENSE.txt for
+further details.

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/calculator

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'glimmer/launcher'
+
+calculator_runner = File.expand_path('../glimmer-cs-calculator', __FILE__)
+launcher = Glimmer::Launcher.new([calculator_runner] + ARGV)
+launcher.launch

data/bin/glimmer-cs-calculator

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/glimmer-cs-calculator'
+
+include Glimmer
+
+calculator.open

data/lib/glimmer-cs-calculator.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.expand_path('..', __FILE__))
+
+require 'glimmer'
+require 'views/glimmer/calculator'

data/lib/models/glimmer/calculator/command.rb

@@ -0,0 +1,89 @@
+module Glimmer
+  class Calculator
+    class Command
+      include EasilyTypable
+      class << self
+        attr_accessor :number1, :number2, :operation
+           
+        # Keyword string representing calculator command (e.g. '+' for Add command)
+        # Subclasses must call to define a single keyword
+        def keyword(keyword_text)         
+          Command.keyword_to_command_class_mapping[keyword_text] = self
+        end
+        
+        # Keyword string array representing calculator command (e.g. ('0'..'9').to_a)
+        # Subclasses must call to define multiple keywords
+        def keywords(*keyword_text_array)
+          keyword_text_array.flatten.each do |keyword_text|
+            keyword(keyword_text)
+          end
+        end
+        
+        def keyword_to_command_class_mapping
+          @keyword_to_command_class_mapping ||= {}
+        end
+      
+        def command_history
+          @command_history ||= []
+        end
+      
+        def for(button)
+          command_class = keyword_to_command_class_mapping[button]
+          command_class&.new(button)&.tap do |command|
+            command.execute
+            command_history << command
+          end
+        end
+      end
+      
+      attr_reader :button
+      attr_accessor :result
+      
+      def initialize(button)
+        @button = button
+      end
+      
+      def number1
+        Command.number1
+      end
+      
+      def number1=(value)
+        Command.number1 = value.to_f
+      end
+      
+      def number2
+        Command.number2
+      end
+      
+      def number2=(value)
+        Command.number2 = value.to_f
+      end
+      
+      def operation
+        Command.operation
+      end
+      
+      def operation=(op)
+        Command.operation = op
+      end
+      
+      def last_result
+        last_command&.result
+      end
+      
+      def last_command
+        command_history.last
+      end
+      
+      def command_history
+        Command.command_history
+      end
+      
+      def execute
+        raise 'Not implemented! Please override in a subclass.'
+      end
+    end
+  end
+end
+
+Dir[File.join(File.dirname(__FILE__), 'command', '**', '*.rb')].each {|f| require(f)}

data/lib/models/glimmer/calculator/command/all_clear.rb

@@ -0,0 +1,17 @@
+module Glimmer
+  class Calculator
+    class Command
+      class AllClear < Command
+        keywords 'AC', 'c', 'C', 27.chr
+
+        def execute
+          self.result = '0'
+          self.number1 = nil
+          self.number2 = nil
+          self.operation = nil
+          command_history.clear
+        end
+      end
+    end
+  end
+end

data/lib/models/glimmer/calculator/command/equals.rb

@@ -0,0 +1,18 @@
+module Glimmer
+  class Calculator
+    class Command
+      class Equals < Command
+        keywords '=', "\r"
+
+        def execute
+          if operation
+            self.result = operation.calculate.to_s
+            self.number1 = self.result
+          else
+            self.result = last_result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/models/glimmer/calculator/command/number.rb

@@ -0,0 +1,20 @@
+module Glimmer
+  class Calculator
+    class Command
+      class Number < Command
+        keywords ('0'..'9').to_a
+              
+        def execute
+          self.result = last_result.nil? || (!last_command.number? && !last_command.point?) ? button : last_result + button
+          if operation.nil? || last_command.equals?
+            self.number1 = self.result
+            self.number2 = nil
+            self.operation = nil            
+          else
+            self.number2 = self.result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/models/glimmer/calculator/command/operation.rb

@@ -0,0 +1,12 @@
+module Glimmer
+  class Calculator
+    class Command
+      class Operation < Command
+        # Calculate operation result using number1 and number2 attributes
+        def calculate
+          raise 'Not implemented! A subclass must implement to calculate operation using number1 and number2 attributes'
+        end
+      end
+    end
+  end
+end

data/lib/models/glimmer/calculator/command/operation/add.rb

@@ -0,0 +1,26 @@
+module Glimmer
+  class Calculator
+    class Command
+      class Operation < Command      
+        class Add < Operation
+          keyword '+'
+
+          def execute          
+            if number2 && operation && !last_command.equals?
+              self.result = operation.calculate.to_s            
+              self.number1 = self.result
+            else
+              self.result = last_result
+              self.operation = self
+            end
+          end
+          
+          def calculate
+            calculation_result = number1 + number2
+            calculation_result.to_s.match(/\.0+$/) ? calculation_result.to_i : calculation_result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/models/glimmer/calculator/command/operation/divide.rb

@@ -0,0 +1,26 @@
+module Glimmer
+  class Calculator
+    class Command
+      class Operation < Command      
+        class Divide < Operation
+          keywords '÷', '/'
+
+          def execute          
+            if number2 && operation && !last_command.equals?
+              self.result = operation.calculate.to_s            
+              self.number1 = self.result
+            else
+              self.result = last_result
+              self.operation = self
+            end
+          end
+          
+          def calculate
+            calculation_result = number1 / number2
+            calculation_result.to_s.match(/\.0+$/) ? calculation_result.to_i : calculation_result #TODO consider moving this to result= method in Command
+          end
+        end
+      end
+    end
+  end
+end

data/lib/models/glimmer/calculator/command/operation/multiply.rb

@@ -0,0 +1,26 @@
+module Glimmer
+  class Calculator
+    class Command
+      class Operation < Command      
+        class Multiply < Operation
+          keywords '×', '*'
+
+          def execute          
+            if number2 && operation && !last_command.equals?
+              self.result = operation.calculate.to_s            
+              self.number1 = self.result
+            else
+              self.result = last_result
+              self.operation = self
+            end
+          end
+          
+          def calculate
+            calculation_result = number1 * number2
+            calculation_result.to_s.match(/\.0+$/) ? calculation_result.to_i : calculation_result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/models/glimmer/calculator/command/operation/subtract.rb

@@ -0,0 +1,26 @@
+module Glimmer
+  class Calculator
+    class Command
+      class Operation < Command      
+        class Subtract < Operation
+          keywords '−', '-'
+
+          def execute          
+            if number2 && operation && !last_command.equals?
+              self.result = operation.calculate.to_s            
+              self.number1 = self.result
+            else
+              self.result = last_result
+              self.operation = self
+            end
+          end
+          
+          def calculate
+            calculation_result = number1 - number2
+            calculation_result.to_s.match(/\.0+$/) ? calculation_result.to_i : calculation_result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/models/glimmer/calculator/command/point.rb

@@ -0,0 +1,20 @@
+module Glimmer
+  class Calculator
+    class Command
+      class Point < Command
+        keyword '.'
+
+        def execute          
+          self.result = last_result.nil? || !last_command.number? ? '0.' : "#{last_result}."
+          if operation.nil? || last_command.equals?
+            self.number1 = self.result
+            self.number2 = nil
+            self.operation = nil            
+          else
+            self.number2 = self.result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/models/glimmer/calculator/presenter.rb

@@ -0,0 +1,18 @@
+require 'models/glimmer/calculator/command'
+
+module Glimmer
+  class Calculator
+    class Presenter
+      attr_accessor :result
+      
+      def initialize
+        self.result = '0'
+      end
+  
+      def press(button)
+        command = Command.for(button)
+        self.result = command.result if command
+      end
+    end
+  end
+end

data/lib/views/glimmer/calculator.rb

@@ -0,0 +1,258 @@
+require 'easily_typable'
+
+require 'models/glimmer/calculator/presenter'
+
+module Glimmer
+  class Calculator
+    include Glimmer::UI::CustomShell
+
+    VERSION = File.read(File.expand_path(File.join('..', '..', '..', '..', 'VERSION'), __FILE__))
+    LICENSE = File.read(File.expand_path(File.join('..', '..', '..', '..', 'LICENSE.txt'), __FILE__))
+
+    ## Add options like the following to configure CustomShell by outside consumers
+    #
+    # options :title, :background_color
+    # option :width, 320
+    # option :height, 240
+
+    ## Uncomment before_body block to pre-initialize variables to use in body
+    #
+    #
+    before_body {
+      @presenter = Presenter.new
+      @button_font = {height: 14}
+      @button_font_operation = {height: 18}
+      @button_font_big = {height: 28}
+      Display.setAppName('Glimmer Calculator')
+      @display = display {
+        on_event_keydown { |key_event|
+          char = key_event.character.chr rescue nil
+          @presenter.press(char)
+        }
+      }
+    }
+
+    ## Uncomment after_body block to setup observers for widgets in body
+    #
+    # after_body {
+    # 
+    # }
+
+    ## Add widget content inside custom shell body
+    ## Top-most widget must be a shell or another custom shell
+    #
+    body {
+      shell {
+        # Replace example content below with custom shell content
+        minimum_size 320, 240
+        text "Glimmer - Calculator"
+        grid_layout 4, true
+        on_about {
+          display_about_dialog
+        }
+        on_preferences {
+          # No need for preferences. Just display about dialog.
+          display_about_dialog
+        }
+        # Setting styled_text to multi in order for alignment options to activate
+        styled_text(:multi, :wrap, :border) {
+          text bind(@presenter, :result)
+          alignment swt(:right)
+          right_margin 5
+          font height: 40
+          layout_data(:fill, :fill, true, true) {
+            horizontal_span 4
+          }
+          editable false
+          caret nil
+        }
+        button {
+          text 'AC'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('AC')
+          }
+        }
+        button {
+          text '÷'
+          font @button_font_operation
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('/')
+          }
+        }
+        button {
+          text '×'
+          font @button_font_operation
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('*')
+          }
+        }
+        button {
+          text '−'
+          font @button_font_operation
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('-')
+          }
+        }
+        button {
+          text '7'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('7')
+          }
+        }
+        button {
+          text '8'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('8')
+          }
+        }
+        button {
+          text '9'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('9')
+          }
+        }
+        button {
+          text '+'
+          font @button_font_big
+          
+          layout_data(:fill, :fill, true, true) {          
+            vertical_span 2
+          }
+          
+          on_widget_selected {
+            @presenter.press('+')
+          }
+        }
+        button {
+          text '4'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('4')
+          }
+        }
+        button {
+          text '5'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('5')
+          }
+        }
+        button {
+          text '6'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('6')
+          }
+        }
+        button {
+          text '1'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('1')
+          }
+        }
+        button {
+          text '2'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('2')
+          }
+        }
+        button {
+          text '3'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('3')
+          }
+        }
+        button {
+          text '='
+          font @button_font_big
+          
+          layout_data(:fill, :fill, true, true) {          
+            vertical_span 2
+          }
+          
+          on_widget_selected {
+            @presenter.press('=')
+          }
+        }
+        button {
+          text '0'
+          font @button_font
+          
+          layout_data(:fill, :fill, true, true) {          
+            horizontal_span 2
+          }
+          
+          on_widget_selected {
+            @presenter.press('0')
+          }
+        }
+        button {
+          text '.'
+          font @button_font_operation
+          
+          layout_data(:fill, :fill, true, true)
+          
+          on_widget_selected {
+            @presenter.press('.')
+          }
+        }
+      }
+    }
+
+    def display_about_dialog
+      message_box = MessageBox.new(swt_widget)
+      message_box.setText("About")
+      message = "Glimmer - Calculator #{VERSION}\n"
+      message += LICENSE
+      message_box.setMessage(message)
+      message_box.open
+    end
+
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: glimmer-cs-calculator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andy Maleh
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  name: glimmer
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  name: easily_typable
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  name: rspec
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+  name: jeweler
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: simplecov
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  name: glimmer-cs-gladiator
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  name: puts_debuggerer
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: Calculator - Glimmer Custom Shell
+email: andy.am@gmail.com
+executables:
+- calculator
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- VERSION
+- bin/calculator
+- bin/glimmer-cs-calculator
+- lib/glimmer-cs-calculator.rb
+- lib/models/glimmer/calculator/command.rb
+- lib/models/glimmer/calculator/command/all_clear.rb
+- lib/models/glimmer/calculator/command/equals.rb
+- lib/models/glimmer/calculator/command/number.rb
+- lib/models/glimmer/calculator/command/operation.rb
+- lib/models/glimmer/calculator/command/operation/add.rb
+- lib/models/glimmer/calculator/command/operation/divide.rb
+- lib/models/glimmer/calculator/command/operation/multiply.rb
+- lib/models/glimmer/calculator/command/operation/subtract.rb
+- lib/models/glimmer/calculator/command/point.rb
+- lib/models/glimmer/calculator/presenter.rb
+- lib/views/glimmer/calculator.rb
+homepage: http://github.com/AndyObtiva/glimmer-cs-calculator
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Calculator - Glimmer Custom Shell
+test_files: []