danica 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c83cfc75834923aafa5160c20aaa1f45b125274d
-  data.tar.gz: 9a7933dd0986b110dee4ee7156452a3ba4027f21
+  metadata.gz: 1a4ece25f84b8d2b7cadc2b68fbd1a6ee4e7d82d
+  data.tar.gz: 00476bd0e01921256126c28be5b08781ed223137
 SHA512:
-  metadata.gz: 48ccbce0f6aa35e90078d8a9006f8f9e2e33119e26abd91cacfdd2496f068f4e4c09bf34a7c89aa109d13807812a2157fd3f4a48bbc2681898445e559d02a37e
-  data.tar.gz: c505f5b99d34053f28b1c5e5c2d1406814acf2f6935d2eb3e9b6f7fd9d7168a9010282fadf0c514f086463206d3bd262298c4551a6c935ebdcad1f7167f15f30
+  metadata.gz: 430fa8144c3d9ef83f41c1a9c0a5d63699d5d8cac5c89c2ed79d97835ebec39a1beb4da6f1cbd68a9540846e93174ec1acfd82ca2c4c50bf90cace854beac782
+  data.tar.gz: '09317ebf09542e77ca54afb320e495143b796689052e5541d532de58b1e12a00fe6879fe663c0481dce008e0c554fe643d14b2bf419734719d9e6bb1be9a5e42'

data/README.md

@@ -38,29 +38,19 @@ class MyOperator < Danica::Operator
   def to_gnu
     #optionaly implement custom to_gnu method
   end
-
-  private
-
-  def to_tex
-    #implement to_tex here
-  end
-
-  def to_gnu
-    #implement to_gnu here
-  end
 end
 ```
+
 #### Sample
 ```ruby
-class Danica::Inverse
+class Danica::Inverse < Danica::Operator
+
   variables :value
 
   def to_f
     value.to_f ** -1 #Do not worry with nil value as this has been implemented already raising Danica::Exception::NotDefined
   end
 
-  private
-
   def to_tex
     "(#{value.to_tex})^{-1}"
   end
@@ -119,7 +109,9 @@ as the base of the power operator and the y variable is present on both power an
 class MyFunction
   variables :variables_list
 
-  # code of operators composition
+  def function_block
+    # code of operators composition
+  end
 end
 ```
 
@@ -128,12 +120,11 @@ end
 module Danica
   class Function::Spatial < Function
     variables :time, :acceleration, :initial_space, :initial_velocity
-    delegate :to_tex, :to_gnu, to: :sum
 
     private
 
-    def sum
-      @sum ||= Sum.new(parcels)
+    def function_block
+      @function_block ||= sum(parcels)
     end
 
     def parcels
@@ -145,15 +136,15 @@ module Danica
     end
 
     def spatial_velocity
-      Product.new(initial_velocity, time)
+      product(initial_velocity, time)
     end
 
     def spatial_acceleration
-      Division.new(Product.new(acceleration, time_squared), 2)
+      division(product(acceleration, time_squared), 2)
     end
 
     def time_squared
-      Power.new(time, 2)
+      power(time, 2)
     end
   end
 end
@@ -173,7 +164,7 @@ fx.to_tex
 
 returns
 ```string
-S_0 + V_0 \cdot t + \frac{a \cdot t^2}{2}
+S_0 + V_0 \cdot t + \frac{a \cdot t^{2}}{2}
 ```
 
 ##### to_gnu
@@ -183,7 +174,7 @@ fx.to_gnu
 
 returns
 ```string
-S0 + V0 * t + a * t**2/2
+S0 + V0 * t + (a * t**(2))/(2)
 ```
 
 ##### calculate / to_f

data/lib/danica.rb

@@ -1,6 +1,7 @@
 require 'active_model'
 
 module Danica
+  autoload :Builder,          'danica/builder'
   autoload :BaseOperations,   'danica/base_operations'
   autoload :VariablesHolder,  'danica/variables_holder'
   autoload :Common,           'danica/common'
@@ -22,6 +23,15 @@ module Danica
   autoload :Exponential,      'danica/exponential'
   autoload :Sin,              'danica/sin'
   autoload :Cos,              'danica/cos'
+  autoload :DSL,              'danica/dsl'
+
+  class << self
+    delegate :build, to: :builder
+
+    def builder
+      @builder ||= Builder.new
+    end
+  end
 
   E = Constant.new(Math::E, :e, 'exp(1)')
   PI =  Constant.new(Math::PI, '\pi', :pi)

data/lib/danica/builder.rb

@@ -0,0 +1,9 @@
+module Danica
+  class Builder
+    include DSL
+
+    def build(&block)
+      instance_eval(&block)
+    end
+  end
+end

data/lib/danica/dsl.rb

@@ -0,0 +1,21 @@
+module Danica
+  module DSL
+    def self.register(method, clazz=nil)
+      define_method method do |*args|
+        clazz = "Danica::#{method.to_s.camelize}".constantize unless clazz
+        clazz.new(*args)
+      end
+    end
+
+    def function(*variables, &block)
+      Function.build(*variables, &block).new
+    end
+  end
+
+  %i(
+    sum product division sin cos power number
+    squared_root exponential group negative
+  ).each do |method|
+    DSL.register(method)
+  end
+end

data/lib/danica/function.rb

@@ -3,12 +3,13 @@ module Danica
     include Common
     include VariablesHolder
     include ActiveModel::Model
+    include DSL
   
     attr_accessor :name
 
     default_value :priority, 3
     default_value :is_grouped?, false
-    delegate :to_f, :to_tex, :to_gnu, to: :function
+    delegate :to_f, :to_tex, :to_gnu, to: :function_block
 
     def self.build(*vars, &block)
       Class.new(self) do
@@ -16,8 +17,8 @@ module Danica
 
         private
 
-        define_method :function do
-          @function ||= instance_eval(&block)
+        define_method :function_block do
+          @function_block ||= instance_eval(&block) if block
         end
       end
     end

data/lib/danica/operator.rb

@@ -11,5 +11,10 @@ module Danica
     def initialize(*args)
       super( variables: args.flatten )
     end
+
+    def ==(other)
+      return false unless other.class == self.class
+      variables == other.variables
+    end
   end
 end

data/lib/danica/version.rb

@@ -1,3 +1,3 @@
 module Danica
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/spec/lib/danica/dsl_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+shared_context 'a class with alias to a clazz' do |aliaz, clazz, *variables|
+  it do
+    expect(subject).to respond_to(aliaz)
+  end
+
+  it "has an alias #{aliaz} for #{clazz}" do
+    expect(subject.public_send(aliaz, *variables)).to eq(clazz.new(*variables))
+  end
+end
+
+shared_context 'a class with mapped dsl' do
+  {
+    sum: Danica::Sum,
+    product: Danica::Product,
+    division: Danica::Division,
+    sin: Danica::Sin,
+    cos: Danica::Cos,
+    power: Danica::Power
+  }.each do |aliaz, clazz|
+    it_behaves_like 'a class with alias to a clazz', aliaz, clazz, 2, 3
+  end
+  {
+    squared_root: Danica::SquaredRoot,
+    exponential: Danica::Exponential,
+    group: Danica::Group,
+    negative: Danica::Negative,
+    number: Danica::Number
+  }.each do |aliaz, clazz|
+    it_behaves_like 'a class with alias to a clazz', aliaz, clazz, 9
+  end
+end
+
+describe Danica::DSL do
+  class Danica::DSL::Dummy
+    include Danica::DSL
+  end
+
+  let(:subject) { described_class::Dummy.new }
+  it_behaves_like 'a class with mapped dsl'
+end

data/spec/lib/danica/function_spec.rb

@@ -33,6 +33,16 @@ describe Danica::Function do
     it 'returns a function thtat knows how to calculate' do
       expect(function.calculate(x: 2, y: 3)).to eq(8)
     end
+
+    context 'when no block is given' do
+      let(:function_class) do
+        described_class.build(*variables)
+      end
+
+      it 'returns a function class' do
+        expect(function_class.superclass).to eq(described_class)
+      end
+    end
   end
 
   describe 'spatial' do

data/spec/lib/danica_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Danica do
+  describe '.build' do
+    let(:result) { described_class.build(&block) }
+
+    context 'when creating a sum' do
+      let(:block) do
+        proc { sum(1, 2) }
+      end
+
+      it 'returns the expected sum' do
+        expect(result).to eq(Danica::Sum.new(1,2))
+      end
+    end
+
+    context 'when creating a power of sum and product' do
+      let(:block) do
+        proc { power(sum(1, 2), product(2,3)) }
+      end
+      let(:expected) do
+        Danica::Power.new(
+          Danica::Sum.new(1, 2),
+          Danica::Product.new(2, 3)
+        )
+      end
+
+      it 'returns the expected power' do
+        expect(result).to eq(expected)
+      end
+    end
+
+    context 'when defining a function' do
+      let(:block) do
+        proc do
+          function(:x) do
+            power(x, 2)
+          end
+        end
+      end
+      let(:function) do
+        Danica::Function.build(:x) do
+          Danica::Power.new(x, 2)
+        end.new
+      end
+
+      it 'returns the expected function with variables' do
+        expect(result.variables_hash).to eq(function.variables_hash)
+      end
+
+      it 'returns the expected function with block' do
+        expect(result.to_tex).to eq(function.to_tex)
+      end
+    end
+  end
+end
+

data/spec/support/models/functions/baskara.rb

@@ -4,20 +4,20 @@ module Danica
 
     private
 
-    def function
-      @function ||= numerator / denominator
+    def function_block
+      @function_block ||= numerator / denominator
     end
 
     def numerator
-       Negative.new(b) + PositiveNegative.new(SquaredRoot.new(delta))
+       negative(b) + PositiveNegative.new(squared_root(delta))
     end
 
     def denominator
-      Number.new(2) * a
+      number(2) * a
     end
 
     def delta
-      Power.new(b, 2) - Product.new(4, a, c)
+      power(b, 2) - product(4, a, c)
     end
   end
 end

data/spec/support/models/functions/gauss.rb

@@ -4,36 +4,36 @@ module Danica
 
     private
 
-    def function
-      @function ||= Product.new(parcels)
+    def function_block
+      @function_block ||= product(parcels)
     end
 
     def parcels
       [
-        Division.new(1, denominator),
-        Exponential.new(exponential)
+        division(1, denominator),
+        exponential(exp)
       ]
     end
 
     def denominator
-      SquaredRoot.new(
-        Product.new(2, PI, variance),
+      squared_root(
+        product(2, PI, variance),
       )
     end
 
-    def exponential
-      Negative.new(
-        Division.new(
-          Power.new(Group.new(
-            Sum.new(x, Negative.new(median))
+    def exp
+      negative(
+        division(
+          power(group(
+            sum(x, negative(median))
           ), 2),
-          Product.new(2, variance)
+          product(2, variance)
         )
       )
     end
 
     def variance
-      @variance ||= Power.new(variance_root, 2)
+      @variance ||= power(variance_root, 2)
     end
   end
 end

data/spec/support/models/functions/spatial.rb

@@ -4,8 +4,8 @@ module Danica
 
     private
 
-    def function
-      @function ||= Sum.new(parcels)
+    def function_block
+      @function_block ||= sum(parcels)
     end
 
     def parcels
@@ -17,15 +17,15 @@ module Danica
     end
 
     def spatial_velocity
-      Product.new(initial_velocity, time)
+      product(initial_velocity, time)
     end
 
     def spatial_acceleration
-      Division.new(Product.new(acceleration, time_squared), 2)
+      division(product(acceleration, time_squared), 2)
     end
 
     def time_squared
-      Power.new(time, 2)
+      power(time, 2)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danica
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -153,10 +153,12 @@ files:
 - docker-compose.yml
 - lib/danica.rb
 - lib/danica/base_operations.rb
+- lib/danica/builder.rb
 - lib/danica/common.rb
 - lib/danica/constant.rb
 - lib/danica/cos.rb
 - lib/danica/division.rb
+- lib/danica/dsl.rb
 - lib/danica/exception.rb
 - lib/danica/exception/not_defined.rb
 - lib/danica/exponential.rb
@@ -184,6 +186,7 @@ files:
 - spec/lib/danica/constant_spec.rb
 - spec/lib/danica/cos_spec.rb
 - spec/lib/danica/division_spec.rb
+- spec/lib/danica/dsl_spec.rb
 - spec/lib/danica/exponential_spec.rb
 - spec/lib/danica/function_spec.rb
 - spec/lib/danica/negative_spec.rb
@@ -195,6 +198,7 @@ files:
 - spec/lib/danica/squared_root_spec.rb
 - spec/lib/danica/sum_spec.rb
 - spec/lib/danica/variable_spec.rb
+- spec/lib/danica_spec.rb
 - spec/spec_helper.rb
 - spec/support/models/functions/baskara.rb
 - spec/support/models/functions/gauss.rb
@@ -238,6 +242,7 @@ test_files:
 - spec/lib/danica/constant_spec.rb
 - spec/lib/danica/cos_spec.rb
 - spec/lib/danica/division_spec.rb
+- spec/lib/danica/dsl_spec.rb
 - spec/lib/danica/exponential_spec.rb
 - spec/lib/danica/function_spec.rb
 - spec/lib/danica/negative_spec.rb
@@ -249,6 +254,7 @@ test_files:
 - spec/lib/danica/squared_root_spec.rb
 - spec/lib/danica/sum_spec.rb
 - spec/lib/danica/variable_spec.rb
+- spec/lib/danica_spec.rb
 - spec/spec_helper.rb
 - spec/support/models/functions/baskara.rb
 - spec/support/models/functions/gauss.rb