shoes-core 4.0.0.pre11 → 4.0.0.pre12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4b04df9c670f569189c22acf3d710762cb070648e055b8caa4df59bd9ee54fc
-  data.tar.gz: c3acdfe4ebb5e220cfa34f1c23ca267805c54e0e1140ecd84f0259dfea5fc4aa
+  metadata.gz: 661b33d7f533fcfeca029b50a73d2825fd861b9cb3dd22b802407c2c9530982a
+  data.tar.gz: 1910df83d014768abe2dbd8fbc4475b857ca9c84c96e85506aa8db8572ce891d
 SHA512:
-  metadata.gz: 4d7b39734d1c215b6d74c9b59c4f3ad6a91f472a7f72dad13881ac05811ced22f44747d021a84ec262e9dff7d0fc72a7ec16b118b4169f7c0358f121c786ab38
-  data.tar.gz: ff7a77a85ea9f3c2c73c15ef602a9dda20d90bd95975d4ab2aa35536cdb6383abad68004ec2459b3ef8bb1ce50c85769e5e09c207ac0fa034281b92f65ecd719
+  metadata.gz: 6955fbb19afbb56560f631f52c139ae43420da5c16cfd4f2cc85bb42114af6fbec7db5f49697fb9ce977f8a64b1b7d6425a4406f7580ed8fd0de0fb13cd56527
+  data.tar.gz: 1d9df772049d179b46c3a70a92c5309a09495812607cdbdc9b4366040d778652dabca4c807e9ff2e2eaf2f8def21f0f335541ee6072f44dfef1ff48e7d0183ab

data/lib/shoes/app.rb

@@ -69,12 +69,16 @@ class Shoes
     end
 
     def quit
+      Shoes.apps.each(&:close)
+    end
+
+    alias exit quit
+
+    def close
       Shoes.unregister self
       @__app__.quit
     end
 
-    alias close quit
-
     def parent
       @__app__.current_slot.parent
     end
@@ -123,16 +127,19 @@ class Shoes
       inspect_details
     end
 
-    DELEGATE_BLACKLIST = [:parent, :app].freeze
-
     # class definitions are evaluated top to bottom, want to have all of them
     # so define at bottom
     DELEGATE_METHODS = ((Shoes::App.public_instance_methods(false) +
-                         Shoes::DSL.public_instance_methods) - DELEGATE_BLACKLIST).freeze
+                         Shoes::DSL.public_instance_methods)).freeze
 
     def self.subscribe_to_dsl_methods(klazz)
+      # Delegate anything in the app/dsl public list that DOESN'T have a method
+      # already defined on the class in question
+      methods_to_delegate = DELEGATE_METHODS - klazz.public_instance_methods
+
       klazz.extend Forwardable unless klazz.is_a? Forwardable
-      klazz.def_delegators :app, *DELEGATE_METHODS
+      klazz.def_delegators :app, *methods_to_delegate
+
       @method_subscribers ||= []
       @method_subscribers << klazz
     end

data/lib/shoes/button.rb

@@ -2,6 +2,7 @@
 class Shoes
   class Button < Common::UIElement
     include Common::Clickable
+    include Common::Focus
     include Common::State
 
     # We don't actually support release from buttons, but want to use the
@@ -14,10 +15,6 @@ class Shoes
       styles[:text] = text || 'Button'
     end
 
-    def focus
-      @gui.focus
-    end
-
     def text=(value)
       style(text: value.to_s)
       @gui.text = value.to_s

data/lib/shoes/check_button.rb

@@ -2,6 +2,7 @@
 class Shoes
   class CheckButton < Common::UIElement
     include Common::Clickable
+    include Common::Focus
     include Common::State
 
     def checked?
@@ -12,10 +13,6 @@ class Shoes
       style(checked: value)
       @gui.checked = value
     end
-
-    def focus
-      @gui.focus
-    end
   end
 
   class Check < CheckButton

data/lib/shoes/common/focus.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+class Shoes
+  module Common
+    module Focus
+      def focus
+        @gui.focus
+      end
+    end
+  end
+end

data/lib/shoes/common/hover.rb

@@ -5,6 +5,10 @@ class Shoes
       attr_reader :hover_blk, :leave_blk
 
       def self.included(base)
+        create_hover_class(base)
+      end
+
+      def self.create_hover_class(base)
         clazz = Class.new {}
         name = base.name.split("::").last
         Shoes.const_set("#{name}Hover", clazz)

data/lib/shoes/configuration.rb

@@ -47,7 +47,7 @@ class Shoes
       # @example
       #   Shoes.configuration.backend_class(shoes_button) # => Shoes::Swt::Button
       def backend_class(object)
-        klazz = object.is_a?(Class) ? object : object.class
+        klazz = object.is_a?(Class) ? object : find_shoes_base_class(object)
         class_name = klazz.name.split("::").last
         # Lookup with false to not consult modules higher in the chain Object
         # because Shoes::Swt.const_defined? 'Range' => true
@@ -55,6 +55,11 @@ class Shoes
         backend.const_get(class_name, false)
       end
 
+      def find_shoes_base_class(object)
+        return object.shoes_base_class if object.respond_to?(:shoes_base_class)
+        object.class
+      end
+
       # Creates an appropriate backend object, passing along additional
       # arguments
       #

data/lib/shoes/core/version.rb

@@ -2,6 +2,6 @@
 
 class Shoes
   module Core
-    VERSION = "4.0.0.pre11"
+    VERSION = "4.0.0.pre12"
   end
 end

data/lib/shoes/dialog.rb

@@ -31,12 +31,12 @@ class Shoes
           flow margin_top: 10 do
             button "OK", margin_left: 150 do
               @result = @e.text
-              quit
+              close
             end
 
             button "Cancel" do
               @result = nil
-              quit
+              close
             end
           end
         end

data/lib/shoes/dsl.rb

@@ -60,6 +60,7 @@ require 'shoes/common/attachable'
 require 'shoes/common/changeable'
 require 'shoes/common/clickable'
 require 'shoes/common/fill'
+require 'shoes/common/focus'
 require 'shoes/common/hover'
 require 'shoes/common/link_finder'
 require 'shoes/common/positioning'

data/lib/shoes/dsl/art.rb

@@ -251,6 +251,14 @@ EOS
 
         create Shoes::Shape, left, top, opts, blk
       end
+
+      def mask(*_)
+        raise Shoes::NotImplementedError,
+              <<~EOS
+                Sorry mask is not supported currently in Shoes 4!
+                Check out github issue #527 for any changes/updates or if you want to help :)
+              EOS
+      end
     end
   end
 end

data/lib/shoes/input_box.rb

@@ -2,6 +2,7 @@
 class Shoes
   class InputBox < Common::UIElement
     include Common::Changeable
+    include Common::Focus
     include Common::State
 
     def before_initialize(styles, text)
@@ -13,10 +14,6 @@ class Shoes
       update_visibility
     end
 
-    def focus
-      @gui.focus
-    end
-
     def text
       @gui.text
     end

data/lib/shoes/list_box.rb

@@ -27,6 +27,7 @@ class Shoes
 
   class ListBox < Common::UIElement
     include Common::Changeable
+    include Common::Focus
     include Common::State
 
     style_with :change, :choose, :common_styles, :dimensions, :items, :state, :text

data/lib/shoes/mock/slot.rb

@@ -18,5 +18,6 @@ class Shoes
 
     class Stack < Slot; end
     class Flow < Slot; end
+    class Widget < Slot; end
   end
 end

data/lib/shoes/oval.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 class Shoes
   class Oval < Common::ArtElement
-    style_with :art_styles, :center, :common_styles, :dimensions, :radius
+    style_with :art_styles, :center, :common_styles, :dimensions
     STYLES = { fill: Shoes::COLORS[:black] }.freeze
 
     def create_dimensions(left, top, width, height)
       left   ||= @style[:left] || 0
       top    ||= @style[:top] || 0
-      width  ||= @style[:diameter] || @style[:width] || (@style[:radius] || 0) * 2
+      width  ||= @style[:width] || @style[:diameter] || (@style[:radius] || 0) * 2
       height ||= @style[:height] || width
 
       @dimensions = AbsoluteDimensions.new left, top, width, height, @style

data/lib/shoes/ui/cli.rb

@@ -7,6 +7,7 @@ require 'shoes/ui/cli/default_command'
 require 'shoes/ui/cli/help_command'
 require 'shoes/ui/cli/manual_command'
 require 'shoes/ui/cli/package_command'
+require 'shoes/ui/cli/samples_command'
 require 'shoes/ui/cli/select_backend_command'
 require 'shoes/ui/cli/version_command'
 
@@ -17,6 +18,7 @@ class Shoes
         help:           HelpCommand,
         manual:         ManualCommand,
         package:        PackageCommand,
+        samples:        SamplesCommand,
         select_backend: SelectBackendCommand,
         version:        VersionCommand,
       }.freeze
@@ -29,7 +31,7 @@ class Shoes
 
       def run(args)
         if args.empty?
-          Shoes::UI::CLI::HelpCommand.new([]).run
+          Shoes::UI::CLI::HelpCommand.new.run
           exit(1)
         end
 
@@ -39,7 +41,7 @@ class Shoes
 
       def create_command(*args)
         command_class = SUPPORTED_COMMANDS[args.first.to_sym] || DefaultCommand
-        command_class.new(args.dup)
+        command_class.new(*args.dup)
       end
     end
   end

data/lib/shoes/ui/cli/base_command.rb

@@ -5,7 +5,7 @@ class Shoes
       class BaseCommand
         attr_reader :args
 
-        def initialize(args)
+        def initialize(*args)
           @args = args
         end
 
@@ -16,11 +16,22 @@ class Shoes
           Shoes.logger.warn("Unexpected extra parameters '#{unexpected}'")
         end
 
-        def self.help
+        def parse!(args)
+          options.parse!(args)
+          true
+        rescue OptionParser::InvalidOption => e
+          puts "Whoops! #{e.message}"
+          puts
+          puts help
+
+          false
+        end
+
+        def help
           nil
         end
 
-        def self.help_from_options(command, options)
+        def help_from_options(command, options)
           lines = ["#{command}\n"] + options.summarize
           lines.join("")
         end

data/lib/shoes/ui/cli/default_command.rb

@@ -16,18 +16,7 @@ class Shoes
           end
         end
 
-        def parse!(args)
-          self.class.options.parse!(args)
-          true
-        rescue OptionParser::InvalidOption => e
-          puts "Whoops! #{e.message}"
-          puts
-          puts self.class.help
-
-          false
-        end
-
-        def self.options
+        def options
           OptionParser.new do |opts|
             # Keep around command dashed options
             opts.on('-v', '--version', 'Shoes version') do
@@ -47,7 +36,7 @@ class Shoes
           end
         end
 
-        def self.help
+        def help
           help_from_options("shoes [options] file", options)
         end
       end

data/lib/shoes/ui/cli/help_command.rb

@@ -13,7 +13,7 @@ class Shoes
           command_classes.concat(SUPPORTED_COMMANDS.map(&:last))
 
           command_classes.each do |command_class|
-            text = command_class.help.to_s
+            text = command_class.new([]).help.to_s
             unless text.empty?
               puts text
               puts
@@ -21,7 +21,7 @@ class Shoes
           end
         end
 
-        def self.help
+        def help
           <<-EOS
 shoes help
     Displays this help text

data/lib/shoes/ui/cli/manual_command.rb

@@ -8,7 +8,7 @@ class Shoes
           Shoes::Manual.run "English"
         end
 
-        def self.help
+        def help
           <<-EOS
 shoes manual
     Run the interactive Shoes manual

data/lib/shoes/ui/cli/package_command.rb

@@ -14,12 +14,12 @@ class Shoes
         rescue OptionParser::InvalidOption => e
           puts "Whoops! #{e.message}"
           puts
-          puts self.class.help
+          puts help
 
           false
         end
 
-        def self.help
+        def help
           help_from_options("shoes package [options] file",
                             Shoes::Packager.new.options) + <<-EOS
 

data/lib/shoes/ui/cli/samples_command.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+require 'fileutils'
+require 'shoes/samples'
+
+class Shoes
+  module UI
+    class CLI
+      class SamplesCommand < BaseCommand
+        attr_accessor :destination_dir
+
+        def run
+          if parse!(args)
+            source = Shoes::Samples.path
+            destination = File.join((destination_dir || Dir.pwd), "shoes_samples")
+
+            if File.exist?(destination)
+              puts "Oops, #{destination} already exists! Try somewhere else, maybe with -d."
+            else
+              FileUtils.cp_r source, destination
+            end
+          end
+        end
+
+        def options
+          OptionParser.new do |opts|
+            opts.on('-dDEST', '--destination=DEST', 'Destination directory') do |destination|
+              self.destination_dir = destination
+            end
+          end
+        end
+
+        def help
+          help_from_options("shoes samples [options]",
+                            options) + <<-EOS
+
+    Installs samples to try out.
+EOS
+        end
+      end
+    end
+  end
+end

data/lib/shoes/ui/cli/select_backend_command.rb

@@ -9,7 +9,7 @@ class Shoes
           Shoes::UI::Picker.new.run(ENV["SHOES_BIN_DIR"], backend)
         end
 
-        def self.help
+        def help
           <<-EOS
 shoes select_backend [backend]
     Select a Shoes backend to use. A backend can be specified, or Shoes will

data/lib/shoes/ui/cli/version_command.rb

@@ -7,7 +7,7 @@ class Shoes
           puts "Shoes #{Shoes::Core::VERSION}"
         end
 
-        def self.help
+        def help
           <<-EOS
 shoes version
     Prints the current Shoes version

data/lib/shoes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Shoes
-  VERSION = "4.0.0.pre11"
+  VERSION = "4.0.0.pre12"
 end

data/lib/shoes/widget.rb

@@ -2,17 +2,22 @@
 class Shoes
   # This is the superclass for creating custom Shoes widgets.
   #
-  # To use, inherit from {Shoes::Widget}. You get a few magical effects:
+  # To use, inherit from {Shoes::Widget} and implement a initialize_widget
+  # method. You get a few magical effects:
   #
   # * When you inherit from {Shoes::Widget}, you get a method in your Apps to
   #   create your widgets. The method is lower- and snake-cased. It returns
   #   an instance of your widget class.
+  #
   # * Your widgets delegate missing methods to their app object. This
   #   allows you to use the Shoes DSL within your widgets.
   #
+  # * Your widget otherwise behaves like a flow. If the final parameter to
+  #   the widget method is a Hash, that will initialize the flow as well.
+  #
   # @example
   #   class SayHello < Shoes::Widget
-  #     def initialize word
+  #     def initialize_widget word
   #       para "Hello #{word}", stroke: green, size: 80
   #     end
   #   end
@@ -21,40 +26,47 @@ class Shoes
   #     say_hello 'Shoes'
   #   end
   #
-  class Widget
-    include Common::Inspect
-
+  class Widget < Shoes::Flow
     Shoes::App.subscribe_to_dsl_methods self
 
-    attr_accessor :parent
-    attr_writer :app
+    attr_accessor :original_args
 
-    class << self
-      attr_accessor :app
+    # Having Widget define initialize makes it easier for us to detect whether
+    # subclasses have inappropriately overridden it or not.
+    def initialize(*_)
+      super
     end
 
-    # lookup a bit more complicated as during initialize we do
-    # not have @app yet...
-    def app
-      @app || self.class.app
+    def initialize_widget
+      # Expected to be overridden by children but not guaranteed
+    end
+
+    def shoes_base_class
+      Shoes::Widget
     end
 
     def self.inherited(klass, &_blk)
+      # Ensure Hover styling class exists, but Widget gets hover behavior from parents
+      Shoes::Common::Hover.create_hover_class(klass)
+
       dsl_method = dsl_method_name(klass)
-      Shoes::App.new_dsl_method(dsl_method) do |*args, &blk|
-        # we set app 2 times because widgets execute most of their code
-        # straight in initialize. I dunno if there is a good way of setting
-        # an @app instance variable before initialize is executed. We could
-        # hand it over in #initialize but that would break the interface
-        # and people would have to set it themselves or make sure to call
-        # super so for not it's like this.
-        # Setting the ref on the instance is important as we might have
-        # instances of the same widget in different Shoes::Apps so each one
-        # needs to save the reference to the one it was started with
-        klass.app              = self
-        widget_instance        = klass.new(*args, &blk)
-        widget_instance.app    = self
-        widget_instance.parent = @__app__.current_slot
+      Shoes::App.new_dsl_method(dsl_method) do |*args|
+        # Old-school widgets that try to use initialize instead of
+        # initialize_widget will get a warning before they likely fail on new.
+        klass.warn_about_initialize
+
+        # If last arg is a Hash, pass that to the underlying Flow
+        container_args = args.last.is_a?(Hash) ? args.last : {}
+
+        # Expected to call through to initialize our underlying slot behavior
+        widget_instance = klass.new(@__app__, @__app__.current_slot, container_args)
+
+        # Call the user's widget initialization, with proper slot context
+        old_current_slot = @__app__.current_slot
+        @__app__.current_slot = widget_instance
+        widget_instance.initialize_widget(*args)
+        @__app__.current_slot = old_current_slot
+
         widget_instance
       end
     end
@@ -64,5 +76,16 @@ class Shoes
            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
            .gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
     end
+
+    def self.warn_about_initialize
+      if instance_method(:initialize).owner != Shoes::Widget
+        Shoes.logger.warn <<~EOS
+          You've defined an `initialize` method on class '#{self}'. This is no longer supported.
+                Your widget likely won't display, and you'll potentially receive argument errors.
+
+                Instead, define `initialize_widget` and we'll call it from your generated widget method.
+        EOS
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shoes-core
 version: !ruby/object:Gem::Version
-  version: 4.0.0.pre11
+  version: 4.0.0.pre12
 platform: ruby
 authors:
 - Team Shoes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies: []
 description: Shoes is the best little GUI toolkit for Ruby. Shoes makes building for
   Mac, Windows, and Linux super simple. This is the DSL for writing your app. You'll
@@ -45,6 +45,7 @@ files:
 - lib/shoes/common/changeable.rb
 - lib/shoes/common/clickable.rb
 - lib/shoes/common/fill.rb
+- lib/shoes/common/focus.rb
 - lib/shoes/common/hover.rb
 - lib/shoes/common/image_handling.rb
 - lib/shoes/common/inspect.rb
@@ -149,6 +150,7 @@ files:
 - lib/shoes/ui/cli/help_command.rb
 - lib/shoes/ui/cli/manual_command.rb
 - lib/shoes/ui/cli/package_command.rb
+- lib/shoes/ui/cli/samples_command.rb
 - lib/shoes/ui/cli/select_backend_command.rb
 - lib/shoes/ui/cli/version_command.rb
 - lib/shoes/ui/picker.rb
@@ -180,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: The best little DSL for the best little GUI toolkit for Ruby.