barretina 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffc7c0e9a4bd67952488271345c86b2ac78177de604ca0c66df617c2243c8be4
-  data.tar.gz: 578af134723316525a9c79de0094c8395d43671e67ea17cbe19c74a1d2b5d492
+  metadata.gz: ac558fc394ad22a35a7f4d7611e64107524bb58bbf9419eea8f91add82d2b074
+  data.tar.gz: 66ceeb22ab0a69276788fe5f61f0e772aaeec59343df8bb4bbe115a6e9714bb8
 SHA512:
-  metadata.gz: 869f990d92768bf90b2cdbafddc91afba9bac0220bce72e8967c6413e44e329b54e6f26f05a78202a4861f990d37c83540decd03666a4032be840033e78ad4e5
-  data.tar.gz: 1769112e3d0abe5967e7a11d425481d3156d44d5d515f98c3a89e9158be7513e9b7a58498f335ff2d4f42906b039f6164cff569f32e034272d354d5e24120204
+  metadata.gz: 77550d27f80a4bb48a6544ff3b670cdfa7693c3b6ac8d10034341800d7dcaa633dc5a2f6acd6f7f71a7ffdda272b68e6e2c7910a309c683fed99fd427f2bd5ee
+  data.tar.gz: 7b7409f66cff4d22c3e363b2ef872f607072d9a3d0f29778541025677c3435e354ab56737c46a3c80fdb2d3be5b5b16a0a996de7c0a0878c148b008a337f1639

data/Gemfile

@@ -5,3 +5,5 @@ source "https://rubygems.org"
 gemspec
 
 gem "minitest", "~> 5.25"
+
+gem "rake", "~> 13.3"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    barretina (0.1.2)
+    barretina (0.2.0)
       irb (~> 1.15)
       ruby2d (~> 0.12.1)
 
@@ -22,6 +22,7 @@ GEM
     psych (5.2.6)
       date
       stringio
+    rake (13.3.0)
     rdoc (6.14.2)
       erb
       psych (>= 4.0.0)
@@ -37,6 +38,7 @@ PLATFORMS
 DEPENDENCIES
   barretina!
   minitest (~> 5.25)
+  rake (~> 13.3)
 
 BUNDLED WITH
    2.6.9

data/README.md

@@ -1,10 +1,10 @@
-Barretina v0.2.0
+Barretina v0.2.1
 =========
 **WORK IN PROGRESS**
 
 A 2D and 3D figure modeler.
 
-Or, in other words: my own Blender.
+Or, in other words: _my own Blender_.
 
 ## Why?
 
@@ -24,12 +24,22 @@ I write in a diary every big commit, and I summarize the evolution of the projec
     - [Run BCM](#run-bcm)
 - [Tests](#tests)
     - [Run tests](#run-tests)
+        - [Using Rake](#using-rake)
+        - [Test files separately](#test-files-separately)
+- [Algebraic classes](#algebraic-classes)
+    - [Generic vectors](#generic-vectors)
+        - [Vector](#vector)
+        - [Line](#line)
+    - [2D vectors](#2d-vectors)
+    - [3D vectors](#3d-vectors)
 
 ## BCM: Barretina Console Mode
 
-BCM is a way to run all Barretina's code without the graphic interface. I created with the intention to test while I work on this project.
+BCM is a way to run all Barretina's code without the graphic interface. I created with the intention to review the code while working on this project.
 
-Actually, it's IRB but with a particular configuration.
+It's really usefull to work with the algebraic classes about vector spaces.
+
+In fact, it's IRB but with a particular configuration.
 
 ### Run BCM
 
@@ -48,11 +58,36 @@ bcm:003:0> p + q
 
 ## Tests
 
-I use [Minitest](https://github.com/minitest/minitest) to create some unit tests.
+This project uses [Minitest](https://github.com/minitest/minitest).
+
+All tests are situated in `test/`, and actually them only review the geometry classes.
 
 ### Run tests
 
-At the moment, you can run the tests manually as a Ruby file. Eg:
+#### Using Rake
+
+Using the `rake` command will execute the tests.
+
+It's recomended to use a specific command to only start the tests under the Bundle
+
+```
+$ bundle exec rake test
+Run options: --seed 17133
+
+# Running:
+
+................................................
+
+Finished in 0.004434s, 10826.1088 runs/s, 30448.4310 assertions/s.
+
+48 runs, 135 assertions, 0 failures, 0 errors, 0 skips
+```
+
+To see other options, read the [Minitest official documentation](https://github.com/minitest/minitest?tab=readme-ov-file#rake-tasks-).
+
+#### Test files separately
+
+It's possible to choose the files to run, using the Ruby command and the path of the file:
 
 ```
 $ ruby test/barretina/vector_space/test_vector.rb
@@ -67,4 +102,74 @@ Finished in 0.003157s, 2851.0290 runs/s, 19006.8599 assertions/s.
 9 runs, 60 assertions, 0 failures, 0 errors, 0 skips
 ```
 
-Eventually, I will reorganize in a Rake file.
+## Algebraic classes
+
+### Generic vectors
+
+I came up with the idea for this project because I awas studying algebra, which had vector spaces as main subject matter.
+
+For that reason, I started with a class to work with vectors: `Barretina::VectorSpace::Vector`.
+
+This class can work with vectors from all dimensions, but at the same time is to slow for a render application. In order to create a better app, there is a module specific for 2D vectors (and will be another for 3D).
+
+But was really fun to implement that class and study how ruby can adapt the behavior for every number of dimensions.
+
+#### Vector
+
+For definition, a vector can add with another and results into a vector, and also can be scaled by a scalar number (integer or rational).
+
+The `Barretina::VectorSpace::Vector` meet the requeriments.
+
+**Important**: the vectors only work correctly with other vectors in same dimension.
+
+The `BCM` interpreter has includeds the different vector spaces modules, then it's possible to invoke `Barretina::VectorSpace::Vector` with only `Vector`.
+
+```
+$ bin/bcm
+BCM - Barretina Console Mode
+bcm:001:0> v = Vector.new(1, 3, 5, 1)
+-> #<Vector (1, 3, 5, 1)>
+bcm:002:0> w = Vector[2, 2, 3, -1]
+-> #<Vector (2, 2, 3, -1)>
+bcm:003:0> v + w
+-> #<Vector (3, 5, 8, 0)>
+bcm:004:0> v - w
+-> #<Vector (-1, 1, 2, 2)>
+bcm:005:0> v * 3
+-> #<Vector (3, 9, 15, 3)>
+bcm:006:0> v.to_s
+-> "(1, 3, 5, 1)"
+bcm:007:0> "#{v} + #{w} = #{v + w}"
+-> "(1, 3, 5, 1) + (2, 2, 3, -1) = (3, 5, 8, 0)"
+```
+
+#### Line
+
+It's possible to have a line object, `Barretina::VectorSpace::Line`, that includes two vectors and can calculate the distance between both:
+
+```
+$ bin/bcm
+BCM - Barretina Console Mode
+bcm:001:0> v = Vector.new(1, 3, 5, 1)
+-> #<Vector (1, 3, 5, 1)>
+bcm:002:0> w = Vector[2, 2, 3, -1]
+-> #<Vector (2, 2, 3, -1)>
+bcm:003:0> l = Line.new(v, w)
+-> #<Line (1, 3, 5, 1)-(2, 2, 3, -1)>
+bcm:004:0> l.length
+-> 3.1622776601683795
+```
+
+### 2D vectors
+
+In that module there are three important elements to calculate the objects to render: vectors, lines and polygons.
+
+- `Barretina::VectorSpace2D::Vector2D`
+- `Barretina::VectorSpace2D::Line2D`
+- `Barretina::VectorSpace2D::Polygon`
+
+All of these are usefull to calculate the objects coordenates and transformations to start with graphic rendering.
+
+### 3D vectors
+
+At the moment I didn't started with 3D spaces.

data/Rakefile

@@ -0,0 +1,5 @@
+require "minitest/test_task"
+
+Minitest::TestTask.create # named test, sensible defaults
+
+task :default => :test

data/lib/barretina/vector_space/vector.rb

@@ -4,7 +4,7 @@ module Barretina
   module VectorSpace
     class Vector
       def self.[](*args)
-        Vector.new *args
+        Vector.new(*args)
       end
 
       attr_accessor :coordenates
@@ -26,7 +26,7 @@ module Barretina
       end
 
       def * scalar
-        Vector.new *coordenates.map { |c| c * scalar }
+        Vector.new(*coordenates.map { |c| c * scalar })
       rescue => e
         raise "Scalar value must be a Numeric instance (recomended Integer or Float), not a #{scalar.class}" unless scalar.is_a? Numeric
         raise e
@@ -53,7 +53,7 @@ module Barretina
         end
 
         def add vector, &block
-          Vector.new *[coordenates, vector.coordenates].transpose.map(&block)
+          Vector.new(*[coordenates, vector.coordenates].transpose.map(&block))
         rescue IndexError => e
           raise IndexError, "Impossible add or substract vectors with different dimesions"
         rescue => e

data/lib/barretina/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Barretina
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: barretina
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ricard Ferrero
@@ -54,6 +54,7 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - bin/barretina
 - bin/bcm
 - lib/barretina.rb