Merge pull request #66 from abinashmeher999/rubocop

Introducing Rubocop

Author: isuruf

.rubocop.yml

@@ -0,0 +1,19 @@
+inherit_from: .rubocop_todo.yml
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%W': '[]'
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+    # The `braces_for_chaining` style enforces braces around single line blocks
+    # and do..end around multi-line blocks, except for multi-line blocks whose
+    # return value is being chained with another method (in which case braces
+    # are enforced).
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Max: 16
+

.rubocop_todo.yml

@@ -0,0 +1,32 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-10-06 20:09:56 +0530 using RuboCop version 0.42.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/Eval:
+  Exclude:
+    - 'lib/symengine.rb'
+
+# Offense count: 28
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 178
+
+# Offense count: 8
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/symengine.rb'
+    - 'lib/symengine/basic.rb'
+    - 'lib/symengine/complex.rb'
+    - 'lib/symengine/complex_double.rb'
+    - 'lib/symengine/integer.rb'
+    - 'lib/symengine/iruby.rb'
+    - 'lib/symengine/undef_function.rb'
+

.travis.yml

@@ -26,7 +26,7 @@ matrix:
   include:
     - os: linux
       rvm: 2.0
-      env: BUILD_TYPE="Debug" WITH_BFD="yes" WITH_MPC="yes"
+      env: BUILD_TYPE="Debug" WITH_BFD="yes" WITH_MPC="yes" RUBOCOP="yes"
     - os: linux
       rvm: 2.3.0
       env: BUILD_TYPE="Debug" WITH_BFD="yes" WITH_MPC="yes"
@@ -66,6 +66,8 @@ script:
   - export CFLAGS="-Werror"
   # Install ruby gem
   - gem install symengine-0.1.0.gem --install-dir $HOME --verbose -- -DSymEngine_DIR=$our_install_dir
+  # Check for code style using rubocop
+  - if [[ "${RUBOCOP}" == "yes" ]]; then rubocop; fi
 
   # Test ruby gem
   - gem install gem-path --no-ri --no-rdoc

ext/symengine/extconf.rb

@@ -2,14 +2,14 @@
 
 ruby_executable = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['RUBY_INSTALL_NAME'] + RbConfig::CONFIG['EXEEXT'])
 
-generator = ""
-
-if (RbConfig::CONFIG['host_os'] =~ /mingw/)
-    generator = '-G "MSYS Makefiles"'
-elsif (RbConfig::CONFIG['host_os'] =~ /cygwin/)
-    generator = '-G "Unix Makefiles"'
-elsif (RbConfig::CONFIG['host_os'] =~ /mswin/)
-    generator = '-G "NMake Makefiles"'
+generator = ''
+
+if RbConfig::CONFIG['host_os'] =~ /mingw/
+  generator = '-G "MSYS Makefiles"'
+elsif RbConfig::CONFIG['host_os'] =~ /cygwin/
+  generator = '-G "Unix Makefiles"'
+elsif RbConfig::CONFIG['host_os'] =~ /mswin/
+  generator = '-G "NMake Makefiles"'
 end
 
-exec 'cmake %s -DCMAKE_INSTALL_PREFIX=../../ -DRUBY_EXECUTABLE=%s %s ../../ ' % [generator, ruby_executable, ARGV.join(" ")]
+exec format('cmake %s -DCMAKE_INSTALL_PREFIX=../../ -DRUBY_EXECUTABLE=%s %s ../../ ', generator, ruby_executable, ARGV.join(' '))

lib/symengine.rb

@@ -13,10 +13,10 @@ class << self
     #    x, y = SymEngine.symbols(['x', 'y'])
     #    x, y = SymEngine.symbols('x', 'y')
     #    x, y = SymEngine.symbols('x y')
-    #    
-    def symbols ary_or_string, *params
+    #
+    def symbols(ary_or_string, *params)
       # Want to make sure we can accept an array or a bunch of splatted arguments
-      if params.size > 0
+      if !params.empty?
         ary_or_string = (ary_or_string.is_a?(String) ? [ary_or_string] : ary_or_string).concat(params)
       elsif ary_or_string.is_a?(String)
         # or accept a string
@@ -25,45 +25,56 @@ def symbols ary_or_string, *params
 
       # Make an Array of SymEngine::Symbols from the parameters we received,
       # now that they're normalized.
-      ary_or_string.map do |symbol_or_string| 
-        SymEngine::Symbol.new(symbol_or_string)
-      end
-    end    
-    def Function(n)
+      ary_or_string.map(&SymEngine::Symbol.method(:new))
+    end
+
+    def Function(n) # rubocop:disable Style/MethodName
       SymEngine::UndefFunction.new(n)
     end
-    def evalf(operand, prec=53, real=false)
+
+    def evalf(operand, prec = 53, real = false)
       _evalf(operand, prec, real)
     end
+
     def lambdify(exp, *syms)
       syms.flatten!
       if exp.free_symbols.count > syms.length
         raise ArgumentError, "Formula contains #{exp.free_symbols.count} free "\
-                             "symbols. You should provide at least this number "\
+                             'symbols. You should provide at least this number '\
                              "of arguments (only #{syms.length} given)."
       end
-      eval(SymEngine::Utils::lambdify_code(exp, syms))
+      # TODO: Implement one of the two options below.
+      # 1. check that all the symbol names and function names are valid.
+      # 2. wrap symengine's LambdaRealDouble into C and then to ruby
+      eval(SymEngine::Utils.lambdify_code(exp, syms))
     end
   end
   module Utils
     class << self
-      REPLACEMENTS = { sin: 'Math.sin', cos: 'Math.cos', tan: 'Math.tan',
-                         asin: 'Math.asin', acos: 'Math.acos', atan: 'Math.atan',
-                         sinh: 'Math.sinh', cosh: 'Math.cosh', tanh: 'Math.tanh',
-                         asinh: 'Math.asinh', acosh: 'Math.acosh', atanh: 'Math.atanh', 
-                         pi: 'Math::PI', E: 'Math::E', I: '::Complex::I',
-                         dirichlet_eta: 'SymEngine::Utils::evalf_dirichlet_eta',
-                         zeta: 'SymEngine::Utils::evalf_zeta', gamma: 'Math.gamma' }.map { |from, to| [/(\b#{from}\b)/, to] }.to_h.freeze
+      REPLACEMENTS = {
+        sin: 'Math.sin', cos: 'Math.cos', tan: 'Math.tan',
+        asin: 'Math.asin', acos: 'Math.acos', atan: 'Math.atan',
+        sinh: 'Math.sinh', cosh: 'Math.cosh', tanh: 'Math.tanh',
+        asinh: 'Math.asinh', acosh: 'Math.acosh', atanh: 'Math.atanh',
+        pi: 'Math::PI', E: 'Math::E', I: '::Complex::I',
+        dirichlet_eta: 'SymEngine::Utils::evalf_dirichlet_eta',
+        zeta: 'SymEngine::Utils::evalf_zeta', gamma: 'Math.gamma'
+      }.map { |from, to|
+        [/(\b#{from}\b)/, to]
+      }.to_h.freeze
+
       def evalf_dirichlet_eta(exp)
-        SymEngine::evalf(SymEngine::dirichlet_eta(exp))
+        SymEngine.evalf(SymEngine.dirichlet_eta(exp))
       end
+
       def evalf_zeta(exp)
-          SymEngine::evalf(SymEngine::zeta(exp))
+        SymEngine.evalf(SymEngine.zeta(exp))
       end
+
       def lambdify_code(exp, syms)
         body = exp.to_s.gsub(/[\d\.]+/, 'Rational(\0,1)')
-        sym_map = syms.join(",")
-        rubified_body = REPLACEMENTS.inject(body) { |res, (from, to)| res.gsub(from, to)}
+        sym_map = syms.join(',')
+        rubified_body = REPLACEMENTS.inject(body) { |res, (from, to)| res.gsub(from, to) }
         "proc { | #{sym_map} | #{rubified_body} }"
       end
     end

lib/symengine/basic.rb

@@ -3,33 +3,39 @@
 module SymEngine
   class Basic
     def inspect
-      "#<#{self.class}(#{to_s})>"
+      "#<#{self.class}(#{self})>"
     end
 
     def free_symbols
       pr_free_symbols.to_set
     end
-    
+
     def abs
-      SymEngine::abs(self)
+      SymEngine.abs(self)
     end
+
     def to_proc(*args)
-      if args.empty?
-        if free_symbols.count > 1
-          raise ArgumentError, "You should provide symbols order for #to_proc"\
-                               ". Only formulae with 1 free symbol can deduce"\
-                               " its name automatically (#{free_symbols.count}"\
-                               " found in #{self})."
-        end
-        SymEngine::lambdify(self, free_symbols.map {|s| s})
-      else
-        if free_symbols.count > args.length
-          raise ArgumentError, "Formula contains #{free_symbols.count} free "\
-                               "symbols. You should provide at least this number "\
-                               "of arguments (only #{args.length} given)."
-        end
-        SymEngine::lambdify(self, args)
+      SymEngine.lambdify(self, args.empty? ? default_args : check_args(*args))
+    end
+
+    def default_args
+      if free_symbols.count > 1
+        raise ArgumentError, 'You should provide symbols order for #to_proc'\
+                             '. Only formulae with 1 free symbol can deduce'\
+                             " its name automatically (#{free_symbols.count}"\
+                             " found in #{self})."
       end
+      free_symbols.to_a
+    end
+
+    def check_args(*args)
+      if free_symbols.count > args.length
+        raise ArgumentError, "Formula contains #{free_symbols.count} free "\
+                             'symbols. You should provide at least this number '\
+                             "of arguments (only #{args.length} given)."
+      end
+
+      args
     end
   end
 end

lib/symengine/complex.rb

@@ -1,7 +1,7 @@
 module SymEngine
   class Complex
     def to_c
-        to_s.tr('I', 'i').delete(' *').to_c
+      to_s.tr('I', 'i').delete(' *').to_c
     end
   end
-end 
+end

lib/symengine/complex_double.rb

@@ -1,7 +1,7 @@
 module SymEngine
   class ComplexDouble
     def to_c
-        to_s.tr('I', 'i').delete(" *").to_c
+      to_s.tr('I', 'i').delete(' *').to_c
     end
   end
-end 
+end

lib/symengine/integer.rb

@@ -1,7 +1,7 @@
 module SymEngine
   class Integer
     def to_int
-        self.to_s.to_i
+      to_s.to_i
     end
   end
 end

lib/symengine/iruby.rb

@@ -2,7 +2,7 @@
   module SymEngine
     class Basic
       def to_iruby
-        ['text/html', self.to_s] unless self.instance_of? Basic
+        ['text/html', to_s] unless instance_of? Basic
       end
     end
   end