aye_commander 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cd9e163ad88759356856bb67d1631806f3a6061
-  data.tar.gz: 92352f5d37a173072f885c6b44c6ae8c4b3bf64e
+  metadata.gz: 41be7b9a74745fe7d3a69b24b334b52900022feb
+  data.tar.gz: 65b0b4de86fa2fb3d75fbc19002e7f8914c0ed5c
 SHA512:
-  metadata.gz: 6737d92b45dfc9becbfb301aa75498affbbca75ddf823179f9cd5c715c55902f9f52a6d30756c8e3bc7ba5f341b77a041aa38bd7f3d8adc928497747a5858b3e
-  data.tar.gz: bfafe03df2dac3af038492aed9e4648f8cfc0cc0610b90edeacbb8cf09bb91e38e3e0bf49d4eda62b414574e81788463a6b5df8b8cbfd479c4b15d1e199fe229
+  metadata.gz: d2d9e76e953e642d10fb0e0dba1e043d67c5d6d0df87f1c4291fed06bcc7a03d78eb8806580e363dbcffd45213b27487b2e37d009887d14b2e5409f644bb13c7
+  data.tar.gz: 32460bc54a9b5abfb10038c6315cfac27551dc48ed1548b65c25f4e6e518dc4e838f52d12b11be82011b81bd4d44183591015fdbad2c5150b5855c07c3921692

data/lib/aye_commander/inspectable.rb

@@ -2,8 +2,7 @@ module AyeCommander
   # This module handles methods that help a command instance represent its
   # contents in different ways.
   module Inspectable
-    # This inspect mimics the one ActiveModel uses so hopefully it will also
-    # look pretty during a pry session when the variables become too many.
+    # This inspect mimics ActiveModel for a better inspection.
     def inspect
       inspection = to_hash.map do |name, value|
         "#{name}: #{value}"
@@ -11,6 +10,22 @@ module AyeCommander
       "#<#{self.class} #{inspection}>"
     end
 
+    # This method mimics ActiveModel pretty_print for a better console output.
+    def pretty_print(pp)
+      pp.object_address_group(self) do
+        ivs = sorted_instance_variables.map(&:to_s)
+        pp.seplist(ivs, proc { pp.text ',' }) do |iv|
+          pp.breakable ' '
+          pp.group(1) do
+            pp.text iv
+            pp.text ':'
+            pp.breakable
+            pp.pp instance_variable_get(iv)
+          end
+        end
+      end
+    end
+
     # Returns a hash of the specified instance_variables
     # Defaults to returning all the currently existing instance variables
     def to_hash(limit = instance_variables)
@@ -32,5 +47,11 @@ module AyeCommander
         to_hash
       end
     end
+
+    # Sorts the instance variables in alphabetical order, but keeps @status at
+    # the beginning for easier inspection
+    def sorted_instance_variables
+      [:@status] | instance_variables.sort
+    end
   end
 end

data/lib/aye_commander/ivar.rb

@@ -2,6 +2,9 @@ module AyeCommander
   # This module contains mostly methods related to method missing and instance
   # variables
   module Ivar
+    AT = '@'.freeze
+    EQ = '='.freeze
+
     # Instance variable related class methods
     module ClassMethods
       # Adds the received reader to the class.
@@ -14,13 +17,21 @@ module AyeCommander
       # Transforms the received name to instance variable form
       # Eg: command -> @command
       def to_ivar(name)
-        name[0] == '@' ? name.to_sym : "@#{name}".to_sym
+        name[0] == at ? name.to_sym : "@#{name}".to_sym
       end
 
       # Transforms the received name to normal variable form
       # Eg: @command -> command
       def to_nvar(name)
-        name[0] == '@' ? name[1..-1].to_sym : name.to_sym
+        name[0] == at ? name[1..-1].to_sym : name.to_sym
+      end
+
+      def at
+        ::AyeCommander::Ivar::AT
+      end
+
+      def eq
+        ::AyeCommander::Ivar::EQ
       end
     end
 
@@ -73,7 +84,7 @@ module AyeCommander
       # Any method that ends with an equal sign will be able to be handled by
       # this method missing.
       def method_missing(name, *args)
-        if name[-1] == '='
+        if name[-1] == self.class.eq
           var_name = to_ivar(name[0...-1])
           instance_variable_set var_name, args.first
           self.class.uses name[0...-1]
@@ -87,7 +98,7 @@ module AyeCommander
       private
 
       def respond_to_missing?(name, *args)
-        name[-1] == '=' || super
+        name[-1] == self.class.eq || super
       end
     end
   end

data/lib/aye_commander/version.rb

@@ -1,3 +1,3 @@
 module AyeCommander
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/aye_commander/inspectable_spec.rb

@@ -12,6 +12,13 @@ describe AyeCommander::Inspectable do
     end
   end
 
+  context '#pretty_print' do
+    it 'gives a pretty print representation of the innards of the class' do
+      pretty_print = PP.pp(instance, ''.dup)
+      expect(pretty_print).to match(/#<#<Class:\dx\w+>:\dx\w+\n @status: :success,\n @other: :potato,\n @variable: :something>/)
+    end
+  end
+
   context '#to_hash' do
     it 'gives a hash representation of the innards of the class' do
       result = { :@status => :success, :@variable => :something, :@other => :potato }
@@ -42,4 +49,11 @@ describe AyeCommander::Inspectable do
       expect(instance.to_result_hash).to eq result
     end
   end
+
+  context '#sorted_instance_variables' do
+    it 'sorts the instance variables alphabetically but keeps @status at the beginning' do
+      sorted = %i[@status @other @variable]
+      expect(instance.sorted_instance_variables).to eq sorted
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aye_commander
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - pyzlnar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies: []
 description: A gem that helps to write commands in ruby.
 email: pyzlnar@gmail.com
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A simple command pattern gem