ffi-snap7 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc1fca00d3b8e5fd62c316df27514db3b4c757a3
+  data.tar.gz: 633799146945e5e12aa387126220c1088dc69dbb
+SHA512:
+  metadata.gz: 616e9d56a95af7024fc547b57b810f1fcfdd5f1ed561146d9267476eed886ff6fe7a0ec72a80283273e8f92b1759d3ac4f0227fe597eb7625a4f58b7b99cb6cb
+  data.tar.gz: fb48641bfe01aae8198896d525afbea39922bdd664e14a7c54d0038e433fe56e6d507e26214376da2d601c4242015c01fd5d88ba14d9943d94e7dcb0cd01a54d

data/.gitignore

@@ -22,3 +22,4 @@ tmp
 mkmf.log
 .idea
 .ruby-*
+/.rspec_status

data/.rspec

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

data/Guardfile

@@ -0,0 +1,16 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  watch(%r{^lib/ffi-snap7/(.+)\.rb$})  { |m| "spec/#{m[1]}_spec.rb" }
+end

data/Rakefile

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

data/ffi-snap7.gemspec

@@ -22,4 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "minitest" # for assertions
+  spec.add_development_dependency "guard-rspec"
 end

data/lib/ffi-snap7.rb

@@ -7,6 +7,23 @@ module Snap7
 
   # S7Object
   typedef :pointer, :s7obj
+
+  # parameter numbers
+  P_u16_LocalPort       =  1
+  P_u16_RemotePort      =  2
+  P_i32_PingTimeout     =  3
+  P_i32_SendTimeout     =  4
+  P_i32_RecvTimeout     =  5
+  P_i32_WorkInterval    =  6
+  P_u16_SrcRef          =  7
+  P_u16_DstRef          =  8
+  P_u16_SrcTSap         =  9
+  P_i32_PDURequest      = 10
+  P_i32_MaxClients      = 11
+  P_i32_BSendTimeout    = 12
+  P_i32_BRecvTimeout    = 13
+  P_u32_RecoveryTime    = 14
+  P_u32_KeepAliveTime   = 15
 end
 
 require 'ffi-snap7/version'

data/lib/ffi-snap7/client/client.rb

@@ -4,9 +4,29 @@ module Snap7
 
   class Client
 
+    # @return [Proc]
+    # @see http://www.mikeperham.com/2010/02/24/the-trouble-with-ruby-finalizers/
+    #
+    def self.finalizer(ptr)
+      proc do
+        ptrptr = FFI::MemoryPointer.new :pointer
+        ptrptr.write_pointer ptr
+        Snap7.cli_destroy ptrptr
+      end
+    end
+
+
     def initialize
       @cli       = Snap7.cli_create
       @connected = false
+
+      ObjectSpace.define_finalizer self, self.class.finalizer(@cli)
+    end
+
+
+    # @return [FFI::MemoryPointer] pointer to the native object
+    def to_ptr
+      @cli
     end
 
 
@@ -54,6 +74,22 @@ module Snap7
     end
 
 
+    # @param port [Integer] remote port to connect to
+    def remote_port=(port)
+      p_value = FFI::MemoryPointer.new(:uint16)
+      p_value.write_uint16 port
+      check_rc Snap7.cli_set_param(@cli, P_u16_RemotePort, p_value)
+    end
+
+
+    # @return [Integer]
+    def remote_port
+      p_port = FFI::MemoryPointer.new(:uint16)
+      check_rc Snap7.cli_get_param(@cli, P_u16_RemotePort, p_port)
+      p_port.read_uint16
+    end
+
+
     private
 
 
@@ -64,7 +100,7 @@ module Snap7
 
     def error_text(error)
       text_len = 1024
-      text_ptr = FFI::MemoryPointer.new :pointer, text_len
+      text_ptr = FFI::MemoryPointer.new :char, text_len
       if Snap7.cli_error_text(error, text_ptr, text_len) == 0
         text_ptr.read_string
       else

data/lib/ffi-snap7/client/wrapper.rb

@@ -3,8 +3,8 @@ module Snap7
   # EXPORTSPEC S7Object S7API Cli_Create();
   attach_function :cli_create, :Cli_Create, [], :s7obj
 
-  # EXPORTSPEC void S7API Cli_Destroy(S7Object &Client);
-  # attach_function :cli_destroy, :Cli_Destroy, [:s7obj], :void # FIXME crashes MRI
+  # EXPORTSPEC void S7API Cli_Destroy(S7Object **Client);
+  attach_function :cli_destroy, :Cli_Destroy, [:s7obj], :void
 
   # EXPORTSPEC int S7API Cli_SetSessionPassword(S7Object Client, char *Password);
   attach_function :cli_set_session_password, :Cli_SetSessionPassword, [:s7obj, :string], :int
@@ -27,6 +27,10 @@ module Snap7
   # EXPORTSPEC int S7API Cli_ErrorText(int Error, char *Text, int TextLen);
   attach_function :cli_error_text, :Cli_ErrorText, [:int, :pointer, :int], :int
 
+  # EXPORTSPEC int S7API Cli_GetParam(S7Object Client, int ParamNumber, void *pValue);
+  attach_function :cli_get_param, :Cli_GetParam, [:s7obj, :int, :pointer], :int
 
+  # EXPORTSPEC int S7API Cli_SetParam(S7Object Client, int ParamNumber, void *pValue);
+  attach_function :cli_set_param, :Cli_SetParam, [:s7obj, :int, :pointer], :int
 
 end

data/lib/ffi-snap7/server/server.rb

@@ -12,8 +12,28 @@ module Snap7
     S7AreaDB = 5
 
 
+    # @return [Proc]
+    # @see http://www.mikeperham.com/2010/02/24/the-trouble-with-ruby-finalizers/
+    #
+    def self.finalizer(ptr)
+      proc do
+        ptrptr = FFI::MemoryPointer.new :pointer
+        ptrptr.write_pointer ptr
+        Snap7.srv_destroy ptrptr
+      end
+    end
+
+
     def initialize
       @srv = Snap7.srv_create
+
+      ObjectSpace.define_finalizer self, self.class.finalizer(@srv)
+    end
+
+
+    # @return [FFI::MemoryPointer] pointer to the native object
+    def to_ptr
+      @srv
     end
 
 
@@ -38,6 +58,22 @@ module Snap7
     end
 
 
+    # @param port [Integer] local port to bind to
+    def local_port=(port)
+      p_port = FFI::MemoryPointer.new(:uint16)
+      p_port.write_uint16 port
+      check_rc Snap7.srv_set_param(@srv, P_u16_LocalPort, p_port)
+    end
+
+
+    # @return [Integer]
+    def local_port
+      p_port = FFI::MemoryPointer.new(:uint16)
+      check_rc Snap7.srv_get_param(@srv, P_u16_LocalPort, p_port)
+      p_port.read_uint16
+    end
+
+
     private
 
 
@@ -48,7 +84,7 @@ module Snap7
 
     def error_text(error)
       text_len = 1024
-      text_ptr = FFI::MemoryPointer.new :pointer, text_len
+      text_ptr = FFI::MemoryPointer.new :char, text_len
       if Snap7.srv_error_text(error, text_ptr, text_len) == 0
         text_ptr.read_string
       else

data/lib/ffi-snap7/server/wrapper.rb

@@ -6,13 +6,14 @@ module Snap7
   # EXPORTSPEC S7Object S7API Srv_Create();
   attach_function :srv_create, :Srv_Create, [], :s7obj
 
-  # EXPORTSPEC void S7API Srv_Destroy(S7Object &Server);
-  # FIXME crashes MRI
-  # attach_function :srv_destroy, :Srv_Destroy, [:s7obj], :void
+  # EXPORTSPEC void S7API Srv_Destroy(S7Object **Server);
+  attach_function :srv_destroy, :Srv_Destroy, [:s7obj], :void
 
   # EXPORTSPEC int S7API Srv_GetParam(S7Object Server, int ParamNumber, void *pValue);
+  attach_function :srv_get_param, :Srv_GetParam, [:s7obj, :int, :pointer], :int
 
   # EXPORTSPEC int S7API Srv_SetParam(S7Object Server, int ParamNumber, void *pValue);
+  attach_function :srv_set_param, :Srv_SetParam, [:s7obj, :int, :pointer], :int
 
   # EXPORTSPEC int S7API Srv_Start(S7Object Server);
   attach_function :srv_start, :Srv_Start, [:s7obj], :int

data/lib/ffi-snap7/version.rb

@@ -1,3 +1,3 @@
 module Snap7
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/client/client_spec.rb

@@ -0,0 +1,92 @@
+RSpec.describe Snap7::Client do
+
+  it 'initializes' do
+    subject
+  end
+
+
+  describe 'native object' do
+    it 'is created' do
+      # NOTE: Calling original is important, otherwise the next GC will SEGV!
+      expect(Snap7).to receive(:cli_create).and_call_original
+      subject
+    end
+
+    it 'is destroyed' do
+      GC.start # minimize garbage objects
+      destroyed = []
+      allow(Snap7).to receive(:cli_destroy) { |ptrptr| destroyed << ptrptr.read_pointer }
+
+      cli_ptr = Snap7::Client.new.to_ptr # no ref to Snap7::Client object is kept
+      GC.start; GC.start # second call is often necessary
+
+      assert_includes destroyed, cli_ptr
+    end
+  end
+
+
+  describe '#connected?' do
+    it 'initializes disconnected' do
+      refute subject.connected?
+    end
+  end
+
+
+  describe '#connect' do
+    let(:address) { double }
+    let(:rack) { double }
+    let(:slot) { double }
+
+    it 'connects to default port' do
+      expect(Snap7).to receive(:cli_connect_to).with(FFI::Pointer, address, rack, slot) { 0 }
+      subject.connect address, rack, slot
+    end
+
+    it 'marks as connected' do
+      allow(Snap7).to receive(:cli_connect_to){ 0 }
+      subject.connect address, rack, slot
+
+      assert subject.connected?
+    end
+
+    it 'checks for error' do
+      expect(Snap7).to receive(:cli_connect_to) { 1 }
+      expect(Snap7).to receive(:cli_error_text).with(1, FFI::MemoryPointer, Integer) do |_, ptr, len|
+        assert_equal len, ptr.size
+        ptr.write_string 'error: foo'
+        0
+      end
+
+      assert_raises do
+        subject.connect address, rack, slot
+      end
+    end
+  end
+
+
+  describe '#disconnect' do
+    it 'disconnects' do
+      expect(Snap7).to receive(:cli_disconnect)
+      subject.disconnect
+    end
+
+    it 'marks as disconnected' do
+      allow(Snap7).to receive(:cli_connect_to){ 0 }
+      subject.connect double, double, double
+      assert subject.connected?
+
+      allow(Snap7).to receive(:cli_disconnect)
+      subject.disconnect
+      refute subject.connected?
+    end
+  end
+
+
+  describe '#remote_port' do
+    it 'sets remote port' do
+      assert_equal  102, subject.remote_port
+      subject.remote_port = 2102
+      assert_equal 2102, subject.remote_port
+    end
+  end
+end

data/spec/ffi-snap7_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe Snap7 do
+  it "has a version number" do
+    expect(Snap7::VERSION).not_to be nil
+  end
+end

data/spec/server/server_spec.rb

@@ -0,0 +1,64 @@
+RSpec.describe Snap7::Server do
+
+  it 'initializes' do
+    subject
+  end
+
+
+  describe 'native object' do
+    it 'is created' do
+      # NOTE: Calling original is important, otherwise the next GC will SEGV!
+      expect(Snap7).to receive(:srv_create).and_call_original
+      subject
+    end
+
+    it 'is destroyed' do
+      GC.start # minimize garbage objects
+      destroyed = []
+      allow(Snap7).to receive(:srv_destroy) { |ptrptr| destroyed << ptrptr.read_pointer }
+
+      srv_ptr = Snap7::Server.new.to_ptr # no ref to Snap7::Server object is kept
+      GC.start; GC.start # second call is often necessary
+
+      assert_includes destroyed, srv_ptr
+    end
+  end
+
+
+  describe '#start' do
+    it 'binds to default port' do
+      expect(Snap7).to receive(:srv_start).with(FFI::Pointer) { 0 }
+      subject.start
+    end
+
+    it 'checks for error' do
+      expect(Snap7).to receive(:srv_start) { 1 }
+      expect(Snap7).to receive(:srv_error_text).with(1, FFI::MemoryPointer, Integer) do |_, ptr, len|
+        assert_equal len, ptr.size
+        ptr.write_string 'error: foo'
+        0
+      end
+
+      assert_raises do
+        subject.start
+      end
+    end
+  end
+
+
+  describe '#stop' do
+    it 'stops' do
+      expect(Snap7).to receive(:srv_stop) { 0 }
+      subject.stop
+    end
+  end
+
+
+  describe '#local_port' do
+    it 'sets local port' do
+      assert_equal  102, subject.local_port
+      subject.local_port = 2102
+      assert_equal 2102, subject.local_port
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+
+require "bundler/setup"
+require "ffi-snap7"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.expect_with :minitest
+end

metadata

@@ -1,77 +1,110 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ffi-snap7
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Andy Rohr
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2016-09-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2018-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id001
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
   prerelease: false
-  name: ffi
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        version: "1.6"
-  requirement: *id002
   prerelease: false
-  name: bundler
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id003
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Access to Siemens PLCs, Simulation of Siemens PLCs
-email: 
+email:
 - andy.rohr@mindclue.ch
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
+- ".rspec"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -88,38 +121,36 @@ files:
 - lib/ffi-snap7/server/server.rb
 - lib/ffi-snap7/server/wrapper.rb
 - lib/ffi-snap7/version.rb
+- spec/client/client_spec.rb
+- spec/ffi-snap7_spec.rb
+- spec/server/server_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/arohr/ffi-snap7
-licenses: 
+licenses:
 - LGPLv3
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.29
+rubygems_version: 2.6.13
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: FFI Ruby wrapper for Snap7 (http://snap7.sourceforge.net/)
-test_files: []
-
+test_files:
+- spec/client/client_spec.rb
+- spec/ffi-snap7_spec.rb
+- spec/server/server_spec.rb
+- spec/spec_helper.rb