functio 0.1.0

data/test/doubles/function_double.rb

@@ -0,0 +1,34 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+class FunctionDouble # :nodoc:
+  attr_reader :attributes
+
+  def self.build(attributes)
+    new(attributes)
+  end
+
+  def initialize(attributes)
+    @attributes = attributes
+  end
+
+  def ==(other)
+    attributes == other.attributes
+  end
+end

data/test/doubles/storage_double.rb

@@ -0,0 +1,36 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+class StorageDouble # :nodoc:
+  attr_reader :all
+
+  def initialize(results = {})
+    @find = results[:find]
+    @all = results[:all]
+    @delete = results[:delete]
+  end
+
+  def find(_fields)
+    @find
+  end
+
+  def delete(_fields)
+    @delete
+  end
+end

data/test/doubles/test_expression_double.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'minitest/autorun'
+require 'doubles/expression_double'
+require 'expression_interface_test'
+
+class TestExpressionDouble < Minitest::Test # :nodoc:
+  include ExpressionInterfaceTest
+
+  def setup
+    @object = ExpressionDouble.new
+  end
+end

data/test/doubles/test_function_double.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'minitest/autorun'
+require 'doubles/function_double'
+require 'storable_interface_test'
+
+class TestFunctionDouble < Minitest::Test # :nodoc:
+  include StorableInterfaceTest
+
+  def setup
+    @object = FunctionDouble.new({})
+  end
+end

data/test/doubles/test_storage_double.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'minitest/autorun'
+require 'doubles/storage_double'
+require 'storage_interface_test'
+
+class TestStorageDouble < Minitest::Test # :nodoc:
+  include StorageInterfaceTest
+
+  def setup
+    @object = StorageDouble.new
+  end
+end

data/test/expression_interface_test.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'interface_test_helper'
+
+module ExpressionInterfaceTest # :nodoc:
+  include InterfaceTestHelper
+
+  def test_implements_the_expression_interface
+    assert_implements(@object, :expression, 0)
+    assert_implements(@object, :variables, 0)
+    assert_implements(@object, :evaluate, -1)
+  end
+end

data/test/interface_test_helper.rb

@@ -0,0 +1,25 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+module InterfaceTestHelper # :nodoc:
+  def assert_implements(object, method, arity)
+    assert_respond_to(object, method)
+    assert_equal(arity, object.method(method).arity)
+  end
+end

data/test/license_test_helper.rb

@@ -0,0 +1,49 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'minitest/autorun'
+require 'papers'
+
+# Configures Papers for license compatibility validation.
+Papers.configure do |config|
+  # A whitelist of accepted licenses.
+  config.license_whitelist = ['MIT', 'BSD', 'BSD-2-Clause', 'Ruby', 'GPL-3.0+']
+
+  # The location of your dependency manifest. Defaults to
+  # config/papers_manifest.yml
+  config.manifest_file = File.join('config', 'papers_manifest.yml')
+
+  # Configures Papers to validate licenses for bundled gems. Defaults to true.
+  config.validate_gems = true
+
+  # Configures Papers to validate licenses for included JavaScript and
+  # CoffeScript files. Defaults to true.
+  config.validate_javascript = false
+
+  # Configures Papers to validate licenses for bower components. Defaults to
+  # false.
+  config.validate_bower_components = false
+
+  # Configures Papers to validate licenses for NPM dependencies. Defaults to
+  # false.
+  config.validate_npm_packages = false
+
+  # Configured Papers to ignore NPM dev dependencies. Defaults to false.
+  config.ignore_npm_dev_dependencies = false
+end

data/test/storable_interface_test.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'interface_test_helper'
+
+module StorableInterfaceTest # :nodoc:
+  include InterfaceTestHelper
+
+  def test_implements_the_storable_interface
+    assert_implements(@object.class, :build, 1)
+    assert_implements(@object, :attributes, 0)
+    assert_implements(@object, :==, 1)
+  end
+end

data/test/storage_interface_test.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'interface_test_helper'
+
+module StorageInterfaceTest # :nodoc:
+  include InterfaceTestHelper
+
+  def test_implements_storage_interface
+    assert_implements(@object, :all, 0)
+    assert_implements(@object, :find, 1)
+    assert_implements(@object, :delete, 1)
+  end
+end

data/test/test_data_storage.rb

@@ -0,0 +1,127 @@
+#--
+# Copyright (C) 2016  Cassiano Rocha Kuplich
+#
+# This file is part of Functio.
+#
+# Functio is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Functio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Functio.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'test_helper'
+require 'functio/data_storage'
+require 'fileutils'
+require 'storage_interface_test'
+
+class TestDataStorage < Minitest::Test # :nodoc:
+  include StorageInterfaceTest
+
+  def setup
+    @real_home = ENV['HOME']
+
+    ENV['HOME'] = File.join('/tmp', 'fake_home')
+    @default_data_file = File.join(ENV['HOME'], '.functio', 'functions.csv')
+
+    FileUtils.remove_dir(ENV['HOME'], true)
+    FileUtils.mkdir_p(ENV['HOME'])
+
+    @object = @storage = DataStorage.new
+  end
+
+  def teardown
+    ENV['HOME'] = @real_home
+  end
+
+  def test_store
+    @storage.store(name: 'first', definition: 'record')
+    first = "name,definition\nfirst,record\n"
+
+    assert File.exist?(@default_data_file)
+    assert_equal(first, File.read(@default_data_file))
+
+    @storage.store(name: 'second', definition: 'record')
+    assert_equal(first + "second,record\n", File.read(@default_data_file))
+  end
+
+  def test_find_stored_record
+    set_fixture_csv
+    expected = { name: 'first', definition: 'one' }
+    assert_equal(expected, @storage.find(name: 'first'))
+    assert_equal(expected, @storage.find(definition: 'one'))
+    assert_equal(expected, @storage.find(name: 'first', definition: 'one'))
+
+    expected = { name: 'second', definition: 'two' }
+    assert_equal(expected, @storage.find(name: 'second'))
+    assert_equal(expected, @storage.find(definition: 'two'))
+    assert_equal(expected, @storage.find(name: 'second', definition: 'two'))
+  end
+
+  def test_find_inexistent_record
+    assert_nil(@storage.find(name: 'first'))
+    assert_nil(@storage.find(definition: 'two'))
+
+    set_fixture_csv
+    assert_nil(@storage.find(name: 'something else'))
+    assert_nil(@storage.find(definition: 'something else'))
+    assert_nil(@storage.find(name: 'first', definition: 'two'))
+    assert_nil(@storage.find(other: 'test'))
+  end
+
+  def test_get_all_records
+    assert_equal([], @storage.all)
+
+    set_fixture_csv
+    all_records = @storage.all
+    assert_equal(2, all_records.size)
+    assert_includes(all_records, name: 'first', definition: 'one')
+    assert_includes(all_records, name: 'second', definition: 'two')
+  end
+
+  def test_delete_stored_record
+    set_fixture_csv
+
+    expected = "name,definition\nsecond,two\n"
+    assert @storage.delete(name: 'first')
+    assert_equal(expected, File.read(@default_data_file))
+
+    assert @storage.delete(definition: 'two', name: 'second')
+    refute File.exist?(@default_data_file)
+  end
+
+  def test_delete_from_empty_data
+    refute @storage.delete(name: 'something', definition: 'else')
+  end
+
+  def test_delete_inexistent_record
+    set_fixture_csv
+
+    expected = "name,definition\nfirst,one\nsecond,two\n"
+    fields_cases = [{ name: 'something else' },
+                    { definition: 'something else' },
+                    { other: 'something else' }]
+    fields_cases.each do |fields|
+      refute @storage.delete(fields)
+      assert_equal(expected, File.read(@default_data_file))
+    end
+  end
+
+  private
+
+  def set_fixture_csv
+    FileUtils.mkdir_p(File.dirname(@default_data_file))
+    File.open(@default_data_file, 'a') do |f|
+      f.puts 'name,definition'
+      f.puts 'first,one'
+      f.puts 'second,two'
+    end
+  end
+end