sirens 0.0.1 → 0.1.1

data/lib/sirens/components/constants_list.rb

@@ -4,7 +4,7 @@ module Sirens
 
         # Building
 
-        def renderWith(layout)
+        def render_with(layout)
             layout.render do |component|
                 choices_list do
                     model component.model

data/lib/sirens/components/method_source_code.rb

@@ -3,7 +3,7 @@ module Sirens
 
         # Building
 
-        def renderWith(layout)
+        def render_with(layout)
             layout.render do |component|
                 vertical_stack do
                     text do

data/lib/sirens/components/methods_list.rb

@@ -4,7 +4,7 @@ module Sirens
 
         # Building
 
-        def renderWith(layout)
+        def render_with(layout)
             layout.render do |component|
                 vertical_stack do
 
@@ -36,8 +36,11 @@ module Sirens
                         styles id: :methods_list,
                             show_headers: false
 
+                        column label: '',
+                            get_image_block: component.props[:get_method_image_block]
+
                         column label: 'Methods',
-                            get_text_block: proc{ |method| method }
+                            get_text_block: proc{ |method| method.name }
                     end
 
                     horizontal_stack do

data/lib/sirens/components/modules_list.rb

@@ -3,7 +3,7 @@ module Sirens
 
         # Building
 
-        def renderWith(layout)
+        def render_with(layout)
             layout.render do |component|
 
                 choices_list do
@@ -13,6 +13,9 @@ module Sirens
                         show_headers: true
                     )
 
+                    column label: '',
+                        get_image_block: proc{ |a_module| Icons.icon_for(a_module) }
+
                     column label: 'Namespace modules',
                         get_text_block: proc{ |a_module| a_module.name }
                 end

data/lib/sirens/components/namespaces_list.rb

@@ -3,7 +3,7 @@ module Sirens
 
         # Building
 
-        def renderWith(layout)
+        def render_with(layout)
             layout.render do |component|
 
                 choices_tree do
@@ -11,6 +11,9 @@ module Sirens
 
                     styles show_headers: true
 
+                    column label: '',
+                        get_image_block: proc{ |a_module| Icons.icon_for(a_module) }
+
                     column label: 'Namespaces',
                         get_text_block: proc{ |a_module| a_module.name }
                 end

data/lib/sirens/models/constant_model.rb

@@ -10,7 +10,8 @@ module Sirens
             @value = value
         end
 
-        attr_reader :name, :value
+        attr_reader :name,
+            :value
 
         def display_string()
             value_print_string = value.inspect

data/lib/sirens/models/icons.rb

@@ -0,0 +1,28 @@
+require 'pathname'
+
+module Sirens
+    class Icons
+
+        def self.icons()
+            @icons ||= Hash[
+                ::Module => 'module.png',
+                ::Class => 'class.png',
+                ::Array => 'array.png',
+                ::Hash => 'hash.png',
+                ::TrueClass => 'true.png',
+                ::FalseClass => 'false.png',
+                ::String => 'string.png',
+                ::Integer => 'number.png',
+                ::Float => 'number.png',
+            ]
+        end
+
+        # Initializing
+
+        def self.icon_for(object)
+            filename = icons.fetch(object.class, 'object.png')
+
+            Pathname.new(__FILE__).dirname + '../../../resources/icons/' + filename 
+        end
+    end
+end

data/lib/sirens/models/method.rb

@@ -0,0 +1,94 @@
+module Sirens
+    class Method
+        # Initializing
+
+        def initialize(mod:, name:, visibility:, instance_method:)
+            @mod = mod
+            @name = name
+            @visibility = visibility
+            @is_instance_method = instance_method
+
+            @ruby_method =  @is_instance_method === true ? 
+                @mod.instance_method(@name) : @mod.method(@name)
+
+            @method_filename, @method_line_number = @ruby_method.source_location
+
+            @source_code = nil
+        end
+
+        # Accessing
+
+        attr_reader :mod,
+            :name,
+            :visibility,
+            :is_instance_method,
+            :method_filename,
+            :method_line_number
+
+        # Asking
+
+        def is_public?()
+            visibility == :public
+        end
+
+        def is_protected?()
+            visibility == :protected
+        end
+
+        def is_private?()
+            visibility == :private
+        end
+
+        def is_instance_method?()
+            is_instance_method
+        end
+
+        # Querying
+
+        def icon()
+            if is_public?
+                filename = 'public-method.png'
+            elsif is_protected?
+                filename = 'protected-method.png'
+            elsif is_private?
+                filename = 'private-method.png'
+            else
+                raise RuntimeError.new('Uknown visibility type.')
+            end
+
+            Pathname.new(__FILE__).dirname + '../../../resources/icons/' + filename             
+        end
+
+        def source_location()
+            "#{method_filename}:#{method_line_number}"
+        end
+
+        def source_code()
+            begin
+                @source_code ||= remove_indentation(@ruby_method.comment) +
+                    "\n" +
+                    remove_indentation(@ruby_method.source)                
+            rescue ::MethodSource::SourceNotFoundError => e
+                @source_code = "Could not locate source for #{@mod}::#{@name}"
+            end
+        end
+
+        # Utility methods
+
+        def remove_indentation(source_code)
+            lines = source_code.lines
+
+            indentation = 0
+
+            /^(\s*).*$/.match(lines.first) do |matches|
+                indentation = matches[1].size
+            end
+
+            lines = lines.collect { |line|
+                line.gsub!(/^\s{#{indentation}}/, '')
+            }
+
+            lines.join
+        end
+    end
+end

data/lib/sirens/models/method_model.rb

@@ -8,104 +8,29 @@ module Sirens
         def initialize()
             super()
 
-            @method_name = ValueModel.new
+            @method = ValueModel.new
             @location = ValueModel.new
             @source_code = ValueModel.new
         end
 
-        attr_reader :method_name,
+        attr_reader :method,
             :location,
             :source_code
 
         def set_method(method)
             if method.nil?
-                method_name.set_value(nil)
-                location.set_value(nil)
-                source_code.set_value(nil)
+                @method.set_value(nil)
+                @location.set_value(nil)
+                @source_code.set_value(nil)
 
                 return
             end
 
-            method_name.set_value(method.name)
+            @method.set_value(method)
 
-            method_filename, method_line_number = method.source_location
+            @location.set_value(method.source_location)
 
-            location.set_value("#{method_filename}:#{method_line_number}")
-
-            source_code.set_value(
-                get_source_code_of(method: method, filename: method_filename, line_number: method_line_number)
-            )
-        end
-
-        def get_source_code_of(method:, filename:, line_number:)
-            return 'Native method' if filename.nil? || ! File.exists?(filename)
-
-            source_code = StringIO.new
-
-            lines = File.read(filename).lines
-
-            method_comment = ''
-            comment_line = line_number - 1
-            while line_number >= 0
-                line = lines[comment_line - 1]
-
-                break if ! /^\s*#/.match(line)
-
-                method_comment = line + method_comment
-
-                comment_line -= 1
-            end
-
-            source_code.write(method_comment)
-
-            tail = lines[line_number -1 .. -1].join
-
-            stream = StringIO.new(tail)
-
-            counter = 0
-
-            keywords = ['module', 'class', 'def', 'if', 'while', 'do', 'begin']
-
-            while !stream.eof?
-
-                while !stream.eof? && (c = stream.getc) == ' '
-                    source_code.write(' ')
-                end
-
-                stream.ungetc(c)
-
-                token = stream.gets(' ')
-
-                source_code.write(token)
-
-                token = token.strip
-
-                if token == 'end'
-                    counter -= 1
-                elsif keywords.include?(token)
-                    counter += 1
-                end
-
-                break if counter == 0
-            end
-
-            fix_indentation(source_code.string)
-        end
-
-        def fix_indentation(source_code)
-            lines = source_code.lines
-
-            indentation = 0
-
-            /^(\s*).*$/.match(lines.first) do |matches|
-                indentation = matches[1].size
-            end
-
-            lines = lines.collect { |line|
-                line.gsub!(/^\s{#{indentation}}/, '')
-            }
-
-            lines.join
+            @source_code.set_value(method.source_code)
         end
     end
 end

data/lib/sirens/models/module_browser_model.rb

@@ -115,22 +115,14 @@ module Sirens
         end
 
         def on_method_changed(announcement)
-            method_name = announcement.new_value
+            selected_method = announcement.new_value
 
-            if method_name.nil?
+            if selected_method.nil?
                 method_source_code.set_method(nil)
                 return
             end
 
-            a_module = module_ancestors.selection.value
-
-            if showing_instance_methods?
-                method = a_module.instance_method(method_name)
-            else
-                method = a_module.method(method_name)
-            end
-
-            method_source_code.set_method(method)
+            method_source_code.set_method(selected_method)
         end
 
         # Calculated
@@ -169,23 +161,91 @@ module Sirens
         # Answers all the methods in the given class
         #
         def get_all_methods_in(a_module)
-            return [] if a_module.nil?
-
-            methods = []
-
-            inherit = show_inherit_methods.value
+            all_methods_defined_in(a_module)
+                .reject { |method| method.is_private? if !showing_private_methods? }
+                .reject { |method| method.is_protected? if !showing_protected_methods? }
+                .reject { |method| method.is_public? if !showing_public_methods? }
+        end
 
-            if showing_instance_methods?
-                methods.concat(a_module.private_instance_methods(inherit)) if showing_private_methods?
-                methods.concat(a_module.protected_instance_methods(inherit)) if showing_protected_methods?
-                methods.concat(a_module.public_instance_methods(inherit)) if showing_public_methods?
-            else
-                methods.concat(a_module.private_methods(inherit)) if showing_private_methods?
-                methods.concat(a_module.protected_methods(inherit)) if showing_protected_methods?
-                methods.concat(a_module.public_methods(inherit)) if showing_public_methods?
+        def all_methods_defined_in(mod)
+            return [] if mod.nil?
+
+            modules = show_inherit_methods.value === true ?
+                mod.ancestors : [mod]
+
+            all_methods = []
+
+            modules.each do |a_module|
+                if showing_instance_methods?
+                    all_methods.concat(
+                        a_module.private_instance_methods(false).collect { |method_name|
+                            Sirens::Method.new(
+                                mod: a_module,
+                                name: method_name,
+                                visibility: :private,
+                                instance_method: true
+                            )
+                        }
+                    )
+
+                    all_methods.concat(
+                        a_module.protected_instance_methods(false).collect { |method_name|
+                            Sirens::Method.new(
+                                mod: a_module,
+                                name: method_name,
+                                visibility: :protected,
+                                instance_method: true
+                            )
+                        }
+                    )
+                    
+                    all_methods.concat(
+                        a_module.public_instance_methods(false).collect { |method_name|
+                            Sirens::Method.new(
+                                mod: a_module,
+                                name: method_name,
+                                visibility: :public,
+                                instance_method: true
+                            )
+                        }
+                    )
+                else
+                    all_methods.concat(
+                        a_module.private_methods(false).collect { |method_name|
+                            Sirens::Method.new(
+                                mod: a_module,
+                                name: method_name,
+                                visibility: :private,
+                                instance_method: false
+                            )
+                        }
+                    )
+
+                    all_methods.concat(
+                        a_module.protected_methods(false).collect { |method_name|
+                            Sirens::Method.new(
+                                mod: a_module,
+                                name: method_name,
+                                visibility: :protected,
+                                instance_method: false
+                            )
+                        }
+                    )
+                    
+                    all_methods.concat(
+                        a_module.public_methods(false).collect { |method_name|
+                            Sirens::Method.new(
+                                mod: a_module,
+                                name: method_name,
+                                visibility: :public,
+                                instance_method: false
+                            )
+                        }
+                    )
+                end
             end
 
-            methods.sort
+            all_methods.sort_by { |method| method.name }
         end
 
         ##