flex_array 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 057e0c5de2e5c5b8aa9e5f843fb8c23b59fc738f
-  data.tar.gz: 18fa12c8236e09de40c5926e1461a66bf1408ada
+  metadata.gz: 6222b14c078c26591a64b3bb97c4a1fe2dfa1d48
+  data.tar.gz: 90006c528466e8c16420ad0e03b144f182e9309d
 SHA512:
-  metadata.gz: 9af8a977c9def6b0c070c23a3246f2ed076398ee326b36634dfe8cb8516f3e4c014c16fa6c8a86c7306cbc1ae799b66d6c12774f68914e7a518619d9ddcedcb9
-  data.tar.gz: e087ab7528a539e6970565dd0ecdaa2403e7fe971ebeaa5b6663e145463f137a1de040155f7aeb3a345368a22f9dcf884e1985aa2935a5c370cd8093c2da96b4
+  metadata.gz: f86ba5b8086d23e8d323320ed3229161a6950afc5d8de0b4bd1129efb9aa202c14ade1e6d037157eaff5e8f0192c14a2ccdbd6620eb14b9d809636b1ee0d6ee1
+  data.tar.gz: ddf04804da0710b0a678d8769d1cd33a09d774aea30a333a4808f32eb963095575c17503a32b0f34048862890e6a596b1ae42d63d0adfc30de6264482225db56

data/README.md

@@ -3,6 +3,54 @@
 This project contains the Ruby FlexArray gem. A gem used to facilitate the
 creation and processing of multi-dimensional arrays in a flexible manner.
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flex_array'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flex_array
+
+The flex_array gem itself is found at: ( https://rubygems.org/gems/flex_array )
+
+## Usage
+
+Using flex_array in an application can be as simple as:
+```ruby
+require 'flex_array'
+
+arr1 = FlexArray.new([10,10])                       # 10 by 10 of nil
+arr2 = FlexArray.new([10,10], 0)                    # 10 by 10 of zero
+arr2 = FlexArray.new([1..12,1..12]) {|i| i[0]*i[1]} # Times table.
+
+arr2[4..5,4..5] = 42 #Set the middle of the array.
+
+```
+
 A lot more information on the operation of this gem may be found in the docs
 folder in the Flex_Array_UG, available in both open office (.odt) and portable
 document (.pdf) formats.
+
+## Contributing
+
+#### Plan A
+
+1. Fork it ( https://github.com/PeterCamilleri/flex_array/fork )
+2. Switch to the development branch ('git branch development')
+3. Create your feature branch ('git checkout -b my-new-feature')
+4. Commit your changes ('git commit -am "Add some feature"')
+5. Push to the branch ('git push origin my-new-feature')
+6. Create new Pull Request
+
+#### Plan B
+
+Go to the GitHub repository and raise an issue calling attention to some
+aspect that could use some TLC or a suggestion or an idea.

data/irbt.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+# An IRB + flex array Test bed
+
+require 'irb'
+
+puts "Starting an IRB console with flex array loaded."
+
+if ARGV[0] == 'local'
+  require_relative 'lib/flex_array'
+  puts "flex_array loaded locally: #{FlexArray::VERSION}"
+
+  ARGV.shift
+else
+  require 'flex_array'
+  puts "flex_array loaded from gem: #{FlexArray::VERSION}"
+end
+
+IRB.start

data/lib/flex_array/version.rb

@@ -3,5 +3,5 @@
 #* version.rb - The version string for flex array.
 class FlexArray
   #The version string for flex array.
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/rakefile.rb

@@ -25,22 +25,9 @@ task :reek do |t|
   `reek --no-color lib > reek.txt`
 end
 
-def eval_puts(str)
-  puts str
-  eval str
-end
-
 desc "Run an interactive flex array session."
 task :console do
-  require 'irb'
-  require 'irb/completion'
-  require_relative 'lib/flex_array'
-  eval_puts "@a = FlexArray.new([2,3,4]) {|i| i.clone}"
-  eval_puts "@b = FlexArray.new([2,3,4]) {|i| (i[0]+i[2])*(i[1] + i[2])}"
-  eval_puts "@c = FlexArray.new([0,3])"
-  eval_puts "@d = FlexArray.new([3,3]) {|i| i[0]*3 + i[1]}"
-  ARGV.clear
-  IRB.start
+  system "ruby irbt.rb local"
 end
 
 desc "What version of flex_array is this?"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flex_array
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-01 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,6 +123,7 @@ files:
 - flex_array
 - flex_array.gemspec
 - flex_array.reek
+- irbt.rb
 - lib/flex_array.rb
 - lib/flex_array/array.rb
 - lib/flex_array/flex_array_append.rb