rs_232 2.0.5 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02b47c417da4c2ac9d676ae91bc548663524bfae
-  data.tar.gz: c96c66b86fd82adc7096ac0c3a3d7e095492ed4b
+  metadata.gz: 0b19997f03f98c0496bda194020c1917d87bc185
+  data.tar.gz: 0bbca6b87935a65a3eb780b54eaccc8c0c988f00
 SHA512:
-  metadata.gz: e42240f209342321179a8fe9fb55212d43b87d935f34ea57945efc14173b0fb0b8810b33431e9d36379de5691201c69c0517a5de479ab49971e7240b431280b1
-  data.tar.gz: 2fafebd69fc832811a32165188b1c723480a6079cd40629303ca2b27498611315211cdbb4f2f1381ed54da9a634d488501643ea663d4f5a0c070156d62293545
+  metadata.gz: a683dfd3c2aa42c3399f6fa520059657a6baf76e0299c588588fa10b59b3a70eec4ffe57afed94d0391d8dc6bb3dd38665a9f186e5260eb8592f24fc1c902ece
+  data.tar.gz: 4c1167898a7ce5db45fdc7a4e666fc4d3fee19b0693e6e3c566ea9696dbbcef73217c0d4936cbd498b7687e8a3b67d01f82700c77908d745d30a83d2083d26c2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rs_232 (2.0.5)
+    rs_232 (2.0.6)
 
 GEM
   remote: https://rubygems.org/
@@ -47,11 +47,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (>= 1.5.3)
-  cucumber (>= 1.3.11)
-  pry (>= 0.9.12.6)
-  rake (>= 10.1.1)
-  rake-compiler (>= 0.9.2)
+  bundler (~> 1.5, >= 1.5.3)
+  cucumber (~> 1.3, >= 1.3.11)
+  pry (~> 0.9, >= 0.9.12.6)
+  rake (~> 10.1, >= 10.1.1)
+  rake-compiler (~> 0.9, >= 0.9.2)
   rs_232!
-  rspec (>= 2.14.1)
-  simplecov (>= 0.8.2)
+  rspec (~> 2.14, >= 2.14.1)
+  simplecov (~> 0.8, >= 0.8.2)

data/README.md

@@ -1,12 +1,12 @@
 # Rs232
 
-Native implementation of the Rs-232 conneciton type
+This is a rs-232 implementation as a Ruby extension in C.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'ruby-rs-232'
+    gem 'rs_232'
 
 And then execute:
 
@@ -14,51 +14,192 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install ruby-rs-232
+    $ gem install rs_232
 
 ## Usage
 
 ```ruby
+
 require "rs_232"
 
-class Serial
-  attr_reader :interface
-  include CommPort
-
-  # == constructor with default params
-  #  by default port will be configured with:
-  #
-  #  @baud_rate = 115200  # BAUD_115200
-  #  @data_bits = 8       # DATA_BITS_8
-  #  @parity = 0          # PAR_NONE
-  #  @stop_bits = 1       # STOP_1
-  #  @flow_control = 0    # FLOW_OFF
-  #
-  #
-  def initialize(port)
-    @interface ||= Rs232.new(port)
-  end
-    
-  #
-  # other adapter methods here ...
-  # 
-  # adapter example placed in the lib folder
-  #
-   
-end  
-
-#== Windows
-
-@adapter = Serial.new("COM3") 
-
-#== Linux
-
-@adapter = Serial.new("/dev/tty.usb00000")
-
-#== Darwin
-
-@adapter = Serial.new("/dev/ttyACM0")  
-```
+###### Windows
+
+@adapter = Rs232::Adapter.new("COM3")
+
+###### Linux
+
+@adapter = Rs232::Adapter.new("/dev/tty.usb00000")
+
+###### Darwin
+
+@adapter = Rs232::Adapter.new("/dev/ttyACM0")
+
+###### or implement your own adapter, here is example
+
+class MyAdapter
+    attr_reader :interface
+
+    # == Top level module ::CommPort constants
+    #
+    # :VERSION,
+    #
+    # :BAUD_110,
+    # :BAUD_300,
+    # :BAUD_600,
+    # :BAUD_1200,
+    # :BAUD_2400,
+    # :BAUD_4800,
+    # :BAUD_9600,
+    # :BAUD_19200,
+    # :BAUD_38400,
+    # :BAUD_57600,
+    # :BAUD_115200,
+    #
+    # :DATA_BITS_5,
+    # :DATA_BITS_6,
+    # :DATA_BITS_7,
+    # :DATA_BITS_8,
+    #
+    # :PAR_NONE,
+    # :PAR_ODD,
+    # :PAR_EVEN,
+    #
+    # :STOP_BITS_1,
+    # :STOP_BITS_3,
+    #
+    # :FLOW_OFF,
+    # :FLOW_HARDWARE,
+    # :FLOW_XONXOFF,
+    #
+    # :Impl
+    #
+
+
+    # == constructor with default params
+    #
+    def initialize(port)
+      @interface = CommPort::Rs232.new(port)
+      connect
+    end
+
+    # Open and configure interface
+    #
+    # @return [Bool]
+    #
+    def connect
+      @interface.open
+
+      @interface.baud_rate    = CommPort::BAUD_115200
+      @interface.data_bits    = CommPort::DATA_BITS_8
+      @interface.parity       = CommPort::PAR_NONE
+      @interface.stop_bits    = CommPort::STOP_BITS_1
+      @interface.flow_control = CommPort::FLOW_OFF
+
+      @open                   = open?
+    end
+
+    # == Write function implementation
+    #
+    # @param [String] bytes
+    # @return [Int]
+    #
+    def write(bytes)
+      @interface.write(bytes)
+    end
+
+    # == Closing interface and freeing structures
+    #
+    #  @return  [Bool]
+    #
+    def close
+      @interface.close
+      @open = open?
+      !open?
+    end
+
+    # == Flashing buffer function
+    #
+    def flush
+      @interface.flush
+    end
+
+    # @return [Bool]
+    #
+    def open?
+      @interface && !@interface.closed?
+    end
+
+    # == read() implementation example
+    #
+    # @param +count+ [Int]
+    # @param +blocking+ [Bool]
+    #
+    # @return [String]
+    #
+    # === Alternative implementation:
+    # @usage:
+    #
+    #  +timeout+ = blocking_value ? 15000 : 0
+    #  +@interface.timeout+ = +timeout+
+    #  +@interface.read( +count+ )+
+    #
+    def read(count, blocking = false)
+      array = []
+
+      bytes_count = (count == -1) ? @interface.available? : count
+
+      if blocking
+        bytes = read_io_until(count, count)
+        array.push bytes if bytes
+      else
+        bytes_count.times do
+          byte = @interface.read(1)
+          array.push byte if byte
+        end
+      end
+      array.empty? ? nil : array.join
+    end
+
+    private
+
+    # == simulate blocking function
+    #
+    # @param +count+ [Int]
+    # @param +up_to+ [Int]
+    #
+    # no direct ruby usage
+    #
+    def block_io_until(count, up_to)
+      while @interface.available? < count && up_to > 0
+        up_to -= 1
+      end
+      up_to > 0
+    end
+
+    # == simulate blocking function
+    #
+    # @param +count+ [Int]
+    # @param +up_to+ [Int]
+    #
+    # no direct ruby usage
+    #
+    def read_io_until(count, up_to)
+      until block_io_until(count, up_to)
+        sleep 0.001
+      end
+      read(count)
+    end
+
+end
+
+###### Then =>
+
+adapter = MyAdapter.new("/dev/ttyACM0")
+
+adapter.open? #=> true
+
+adapter.write 'Hello, world!"  #=> 13
 
+```
 
-## Contributing
+## Contributing

data/atlassian-ide-plugin.xml

@@ -0,0 +1,5 @@
+<atlassian-ide-plugin>
+  <project-configuration id="1">
+    <servers id="2" />
+  </project-configuration>
+</atlassian-ide-plugin>

data/cucumber.yml

@@ -2,7 +2,7 @@
 
 rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
 rerun_opts = rerun.to_s.strip.empty? ? "--format progress features" : "--format pretty #{rerun}"
-std_opts = "--format pretty features --tags ~@wip --tag ~@wip-new-core -r features --strict"
+std_opts = "--format pretty features --tags ~@wip -r features --strict"
 
 
 wip_opts = "--color -r features --tags @wip:3,@wip-new-core"
@@ -14,8 +14,8 @@ legacy_opts << " --tags ~@wip-jruby" if defined?(JRUBY_VERSION)
 
 %>
 
-default: <%= std_opts %> --tags ~@jruby features/.cucumber
-windows_mri: <%= std_opts %> --tags ~@jruby --tags ~@spork --tags ~@wire --tags ~@needs-many-fonts CUCUMBER_FORWARD_SLASH_PATHS=true
+default: <%= std_opts %> --tags ~@jruby features
+windows_mri: <%= std_opts %> --tags ~@jruby
 
 ruby_1_9: <%= std_opts %> --tags ~@jruby
 ruby_2_0: <%= std_opts %> --tags ~@jruby

data/ext/rs_232/constants.h

@@ -18,7 +18,7 @@
 #include <ruby.h>
 
 
-#define VERSION "3.0.0-rc"
+#define VERSION "2.0.7"
 
 
 #define LS_CTS  0x01

data/ext/rs_232/extconf.rb

@@ -2,8 +2,8 @@ require 'mkmf'
 require 'rbconfig'
 
 if ENV['DEBUG_C']
-  $CFLAGS << " -DDEBUG"
-  $CFLAGS << " -g -O"
+  $CFLAGS << ' -DDEBUG'
+  $CFLAGS << ' -g -O'
   $stdout.puts "compiling in debug mode... flags: #{$CFLAGS}"
 end
 
@@ -11,82 +11,49 @@ def root(path)
   File.expand_path("../#{path}/", __FILE__)
 end
 
-dir_config("rs_232")
+dir_config('rs_232')
 
 $warnflags = '-Wall'
 
-CPU = case RbConfig::CONFIG['host_cpu'].downcase
-        when /i[3456]86/
-          if RbConfig::CONFIG['host_os'] =~ /darwin/ && 0xfee1deadbeef.is_a?(Fixnum)
-            "x86_64"
-          else
-            "i386"
-          end
-
-        when /amd64|x86_64/
-          "x86_64"
-
-        when /ppc64|powerpc64/
-          "powerpc64"
-
-        when /ppc|powerpc/
-          "powerpc"
-
-        when /^arm/
-          "arm"
-
-        else
-          RbConfig::CONFIG['host_cpu']
-      end
-
-$stdout.puts "Detecting CPU... "
-$stdout.puts "CPU: #{CPU}"
-
 OS = case RbConfig::CONFIG['host_os'].downcase
        when /linux/
-         "linux"
+         'linux'
        when /darwin/
-         "darwin"
+         'darwin'
        when /freebsd/
-         "freebsd"
+         'freebsd'
        when /openbsd/
-         "openbsd"
+         'openbsd'
        when /sunos|solaris/
-         "solaris"
+         'solaris'
        when /mswin|mingw/
-         "windows"
+         'windows'
        else
          RbConfig::CONFIG['host_os'].downcase
      end
 
-$stdout.puts "Detecting OS... "
-$stdout.puts "OS: #{OS}"
-$stdout.puts
-
-
-have_header("ruby.h")
-have_header("port.h")
-have_header("stdio.h")
-
-if OS == "windows"
-  $VPATH << "$(srcdir)/windows"
-  $INCFLAGS += " -I$(srcdir)/windows"
-  have_header("windows.h")
-  have_header("fcntl.h")
-  have_header("io.h")
-  have_header("ruby/io.h")
-  have_header("rubyio.h")
+have_header('ruby.h')
+have_header('stdio.h')
+
+if OS == 'windows'
+  $VPATH << '$(srcdir)/windows'
+  $INCFLAGS += ' -I$(srcdir)/windows'
+  have_header('windows.h')
+  have_header('fcntl.h')
+  have_header('io.h')
+  have_header('ruby/io.h')
+  have_header('rubyio.h')
 elsif %w(linux darwin).include? OS
-  $VPATH << " $(srcdir)/posix"
-  $INCFLAGS += " -I$(srcdir)/posix"
-  have_header("termios.h")
-  have_header("unistd.h")
-  have_header("string.h")
-  have_header("fcntl.h")
-  have_header("errno.h")
-  have_header("sys/ioctl.h")
+  $VPATH << ' $(srcdir)/posix'
+  $INCFLAGS += ' -I$(srcdir)/posix'
+  have_header('termios.h')
+  have_header('unistd.h')
+  have_header('string.h')
+  have_header('fcntl.h')
+  have_header('errno.h')
+  have_header('sys/ioctl.h')
 else
-  raise "RS-233 implementation is not tested for this #{OS} palform."
+  raise "RS-233 implementation is not tested for this #{OS} platform."
 end
 
 $objs = %w(constants.o port.o initializer.o)

data/features/connection.feature

@@ -1,8 +1,10 @@
 Feature: Connection
 
-  Scenario: Should have an ability to check open or not
+  As an QA
+  in order to test connection object I will create new one and ensure that it is opened
 
+  Scenario: Should have an ability to check open or not
 
-    * connection instance "should" be available
-    * I "close" connection
-    * connection instance "should not" be available
+    Given connection instance "should" be available
+     Then I "close" connection
+      And connection instance "should not" be available

data/features/support/after.rb

@@ -1,5 +1,4 @@
 After do
-  adapter.close
-  logger.debug "Closed..."
+  adapter.close if adapter.open?
 end
 

data/features/support/env.rb

@@ -1,7 +1,6 @@
 require 'cucumber'
-require 'cucumber/formatter/unicode'
-require File.expand_path("../../../lib/rs_232", __FILE__)
-require File.expand_path("../adapter", __FILE__)
+require 'rs_232'
+require_relative '../../spec/support/adapter'
 
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 #
@@ -11,33 +10,6 @@ def expand_path(path)
   File.expand_path(path, File.dirname(__FILE__))
 end
 
-
-# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
-#
-# ENV
-#
-config = expand_path '../config/config.yml'
-if File.file? config
-  require 'yaml'
-  env = YAML.load File.read config
-  env.each do |key, value|
-    if ENV['DEBUG'] or env['DEBUG']
-      if ENV[key]
-        puts "Set `#{key}` to `#{ENV[key]}`."
-      else
-        puts "Set `#{key}` to default `#{value}`."
-      end
-    end
-
-    ENV[key] ||= value.to_s if value
-  end
-else
-  if ENV['DEBUG']
-    puts "Please check `features/support/config` folder for existing file `config.yml`"
-    puts
-  end
-end
-
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 #
 # Load only if bundled console
@@ -63,7 +35,7 @@ class LogFormatter < ::Logger::Formatter
   private
 
   def format_datetime(time)
-    time.strftime("%Y-%m-%d %H:%M:%S.") << "%06d " % time.usec
+    time.strftime('%Y-%m-%d %H:%M:%S.') << "%06d " % time.usec
   end
 
 end
@@ -80,21 +52,17 @@ end
 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
 def serial_port
-  if ENV["SERIAL_PORT"].nil?
-    $stdout.write "Enter serial port name: "
-    ENV["SERIAL_PORT"] = $stdin.gets.chomp
+  if ENV['SERIAL_PORT'].nil?
+    $stdout.write 'Enter serial port details: '
+    ENV['SERIAL_PORT'] = $stdin.gets.chomp
   end
-  ENV["SERIAL_PORT"]
+  ENV['SERIAL_PORT']
 end
 
 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
 def adapter
-  @adapter ||= Adapter::Dev.new(serial_port)
-end
-
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-def transmit(string)
-  adpter.tx(string)
-end
+  @adapter ||= Adapter::Dev.new(serial_port) do |message|
+    logger.debug message
+  end
+end

data/gem_tasks/environment.rake

@@ -1,7 +1,7 @@
 task :ruby_env do
   RUBY_APP = if RUBY_PLATFORM =~ /java/
-    "jruby"
-  else
-    "ruby"
-  end unless defined? RUBY_APP
+               'jruby'
+             else
+               'ruby'
+             end unless defined? RUBY_APP
 end

data/gem_tasks/rspec.rake

@@ -1,6 +1,6 @@
 require 'rspec/core/rake_task'
 
-desc "Run RSpec"
+desc 'Run RSpec'
 RSpec::Core::RakeTask.new do |t|
   t.verbose = true
 end

data/lib/rs_232/version.rb

@@ -1,6 +1,6 @@
 module Rs232
   module Version
-    MAJOR, MINOR, PATCH = 2, 0, 5
+    MAJOR, MINOR, PATCH = 2, 0, 7
     STRING              = [MAJOR, MINOR, PATCH].join('.')
   end