rspec-eth 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0460e41d2af3a1fed048da7ed41ec2428ec61ad73a01b3429d4176c93544c3f
+  data.tar.gz: f9e19174ef7b335be205723ab619f036e4fced546cb4d723e6bcd094a7fe5201
+SHA512:
+  metadata.gz: ccfcb90c1699125ea9085f4b2fe816c56b66090ed361a977939cad339ec6d33a1f47f6e69bb731e3e6d3f95d8a845862169663fe4f166e78c1cf5ffb0749eea2
+  data.tar.gz: 85ab20288129b0fcde4ec8f8995fe89b84aeabcf6bf2c7cd5f117aee21e95f5040096e6a83d2d41fec76a3512729175b1371016f0bb41dfb9802c262aa300876

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec-eth.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'rspec-its'
+gem 'pry'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Nikita Misharin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# RSpec::Eth
+
+RSpec extension that allows to easily test solidity smart contracts.
+
+## What it does
+
+* Spins up ganache server for tests
+* Adds a few handy methods to ease testing of solidity contracts in ruby main ones:
+    1. `contract` to access contract
+    2. `accounts` to access addresses used by ganache
+
+It's build on top of [etherium.rb](https://github.com/EthWorks/ethereum.rb). For documentation on how to interact with etherium blockchain please refer to its documentation
+
+## Example Usage
+Given a simple [Greeter contract](https://github.com/TheSmartnik/rspec-eth/blob/master/contracts/simple_greeter.sol). Here is an example of basic spec
+
+```ruby
+RSpec.describe 'SimpleGreeter', type: :smart_contract do
+  before { contract.deploy_and_wait }
+
+  it 'sets greeting' do
+    expect(contract.call.greet).to eq("Hello, World!")
+  end
+
+  it 'changes message' do
+    contract.transact_and_wait.set_super_greeting("Yo")
+
+    expect(contract.call.greet).to eq("Yo")
+  end
+
+  context 'when sender not owner' do
+    before { contract.sender = accounts[1] }
+
+    it 'trying to set not from owner' do
+      expect {
+        contract.transact_and_wait.set_super_greeting("Yo")
+      }.to raise_exception(IOError, "VM Exception while processing transaction: revert Only owner")
+    end
+  end
+end
+```
+
+## Installation
+
+### Prerequisite
+
+1. Install ganache-cli
+```
+npm install -g ganache-cli
+```
+2. [Install solidity compilier](https://docs.soliditylang.org/en/v0.8.9/installing-solidity.html)
+```
+brew install solidity
+```
+
+3. Add gem to a Gemfile
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-eth'
+```
+
+4. Require extension in `spec_helper.rb` or `rails_helper.rb`
+```
+require 'rspec/eth'
+```
+
+## Configuration
+
+`RSpec::Eth` provides a few configuration option that you probably won't need
+
+```ruby
+# spec_helper.rb
+
+RSpec::Eth.configure do |config|
+  config.account_keys_path = temp_path # Path for accounts created
+  config.host = '127.0.0.1' # Host of ganache server
+  config.port = '8545' # Port of ganache server
+  config.contracts_path = 'contracts'# Set paths for your contracts
+end
+
+```
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-eth.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/eth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/eth/config.rb

@@ -0,0 +1,33 @@
+require 'tempfile'
+
+module RSpec
+  module Eth
+    class Config
+      class << self
+        attr_writer :account_keys_path, :port, :host, :contracts_path
+
+        def account_keys_path
+          @account_keys_path || accounts_tempfile.path
+        end
+
+        def port
+          @port || 8545
+        end
+
+        def host
+          @host || '127.0.0.1'
+        end
+
+        def contracts_path
+          @contracts_path || 'contracts'
+        end
+
+        private
+
+        def accounts_tempfile
+          @accounts_tempfile ||= Tempfile.new('rspec-eth')
+        end
+      end
+    end
+  end
+end

data/lib/rspec/eth/helper_methods.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module RSpec
+  module Eth
+    module HelperMethods
+      def client
+        @client ||= begin
+          Ethereum::HttpClient.new("http://#{RSpec::Eth::Config.host}:#{RSpec::Eth::Config.port}")
+        end
+      end
+
+      def contract
+        @contract ||= begin
+          Ethereum::Contract.create(file: contract_path, client: client)
+        end
+      end
+
+      def accounts
+        @accounts ||= begin
+          accounts_data = File.read(RSpec::Eth::Config.account_keys_path)
+          JSON.parse(accounts_data)['addresses'].keys
+        end
+      end
+
+      def contract_path
+        @contract_path ||= begin
+          filename = self.class.metadata[:file_path].split('/').last.gsub('_spec', '').gsub('.rb', '')
+          File.join(RSpec::Eth::Config.contracts_path, "#{filename}.sol")
+        end
+      end
+    end
+  end
+end

data/lib/rspec/eth/rspec.rb

@@ -0,0 +1,19 @@
+require 'rspec/core'
+require 'rspec/eth/helper_methods'
+require 'rspec/eth/server'
+
+RSpec.configure do |config|
+  config.include RSpec::Eth::HelperMethods, type: :smart_contract
+
+  config.after(:all) do |_example|
+    if self.class.include?(RSpec::Eth::HelperMethods)
+      RSpec::Eth::Server.stop
+    end
+  end
+
+  config.before(:all) do |_example|
+    if self.class.include?(RSpec::Eth::HelperMethods)
+      RSpec::Eth::Server.start
+    end
+  end
+end

data/lib/rspec/eth/server.rb

@@ -0,0 +1,37 @@
+module RSpec
+  module Eth
+    class Server
+      class << self
+        attr_accessor :ganache_pid, :ganache_read_output
+
+        def start(wait_until_ready: true)
+          if !ganache_pid
+            self.ganache_read_output, ganache_write_output = IO.pipe
+            options = ["--quiet", "--account_keys_path #{Config.account_keys_path}", "-p #{Config.port}", "-h #{Config.host}"]
+            self.ganache_pid = Process.spawn("ganache-cli #{options.join(" ")}", out: ganache_write_output, err: STDOUT)
+
+            # Enough to understand that that server is ready
+            ganache_read_output.read(60) if wait_until_ready
+          else
+            warn("Server already runnin")
+          end
+        end
+
+        def stop
+          if ganache_pid
+            Process.kill("TERM", ganache_pid)
+            self.ganache_pid = nil
+            self.ganache_read_output = nil
+          else
+            warn("Server isn't running")
+          end
+        end
+
+        def restart
+          start
+          stop
+        end
+      end
+    end
+  end
+end

data/lib/rspec/eth/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Eth
+    VERSION = "0.1.1"
+  end
+end

data/lib/rspec/eth.rb

@@ -0,0 +1,12 @@
+require 'ethereum.rb'
+require 'rspec/eth/version'
+require 'rspec/eth/config'
+require 'rspec/eth/rspec'
+
+module RSpec
+  module Eth
+    def self.configure
+      yield(Config)
+    end
+  end
+end

data/rspec-eth.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/rspec/eth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-eth"
+  spec.version       = RSpec::Eth::VERSION
+  spec.authors       = ["TheSmartnik"]
+  spec.email         = ["misharinn@gmail.com"]
+
+  spec.summary       = %q{RSpec extension that allows to easily test solidity smart contracts}
+  spec.description   = %q{RSpec extension that spins up ganache server for tests and adds a few handy methods. Expected to be used with ethereum.rb}
+  spec.homepage      = "https://github.com/TheSmartnik/rspec-eth"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.licenses      = ['MIT']
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/TheSmartnik/rspec-eth"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|contracts)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'ethereum.rb'
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: rspec-eth
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- TheSmartnik
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ethereum.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSpec extension that spins up ganache server for tests and adds a few
+  handy methods. Expected to be used with ethereum.rb
+email:
+- misharinn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/eth.rb
+- lib/rspec/eth/config.rb
+- lib/rspec/eth/helper_methods.rb
+- lib/rspec/eth/rspec.rb
+- lib/rspec/eth/server.rb
+- lib/rspec/eth/version.rb
+- rspec-eth.gemspec
+homepage: https://github.com/TheSmartnik/rspec-eth
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/TheSmartnik/rspec-eth
+  source_code_uri: https://github.com/TheSmartnik/rspec-eth
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: RSpec extension that allows to easily test solidity smart contracts
+test_files: []