rs_232 2.0.4

data/features/support/env.rb

@@ -0,0 +1,100 @@
+require 'cucumber'
+require 'cucumber/formatter/unicode'
+require File.expand_path("../../../lib/rs_232", __FILE__)
+require File.expand_path("../adapter", __FILE__)
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+# relative path location method
+#
+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
+#
+
+unless $0 =~ /cucumber/i
+  runtime = Cucumber::Runtime.new
+  runtime.load_programming_language('rb')
+end
+
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+# logger impl
+#
+
+class LogFormatter < ::Logger::Formatter
+
+  def call(severity, time, progname, msg)
+    "#{format_datetime(time)}[TID:#{$$}] [EXT::#{severity}]: #{msg}\n"
+  end
+
+  private
+
+  def format_datetime(time)
+    time.strftime("%Y-%m-%d %H:%M:%S.") << "%06d " % time.usec
+  end
+
+end
+
+def logger
+  @logger ||= begin
+    l           = ::Logger.new($stdout)
+    l.level     = Logger::DEBUG
+    l.formatter = LogFormatter.new
+    l
+  end
+end
+
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+def serial_port
+  if ENV["SERIAL_PORT"].nil?
+    $stdout.write "Enter serial port name: "
+    ENV["SERIAL_PORT"] = $stdin.gets.chomp
+  end
+  ENV["SERIAL_PORT"]
+end
+
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+def adapter
+  @adapter ||= Adapter::Dev.new(serial_port)
+end
+
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+def transmit(string)
+  adpter.tx(string)
+end

data/gem_tasks/cov.rake

@@ -0,0 +1,5 @@
+desc 'Run all tests and collect code coverage'
+task :cov do
+  ENV['SIMPLECOV'] = 'features'
+  Rake::Task['default'].invoke
+end

data/gem_tasks/cucumber.rake

@@ -0,0 +1,23 @@
+require 'cucumber/rake/task'
+require 'cucumber/platform'
+
+class Cucumber::Rake::Task
+  def set_profile_for_current_ruby
+    self.profile = if Cucumber::JRUBY
+      Cucumber::WINDOWS ? 'jruby_win' : 'jruby'
+    elsif Cucumber::WINDOWS_MRI
+      'windows_mri'
+    elsif Cucumber::RUBY_1_9
+      'ruby_1_9'
+    elsif Cucumber::RUBY_2_0
+      'ruby_2_0'
+    end
+  end
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.fork = true
+  t.set_profile_for_current_ruby
+end
+
+task :cucumber => :features

data/gem_tasks/doc.rake

@@ -0,0 +1,12 @@
+require 'rdoc/task'
+
+desc "builds documentation for the 'rs_232' gem"
+Rake::RDocTask.new :doc do |rd|
+
+  base = File.expand_path("../", File.dirname(__FILE__))
+  base.sub!(/^#{Regexp::escape FileUtils.pwd}\/?/, './')
+
+  rd.main = File.join(base, "README.md")
+  rd.rdoc_files.include(File.join(base, "README.md"), File.join(base, "lib/**/*.rb"))
+  rd.rdoc_dir = "./doc/rs_232"
+end

data/gem_tasks/environment.rake

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

data/gem_tasks/rspec.rake

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

data/lib/rs_232/version.rb

@@ -0,0 +1,8 @@
+module Rs232
+  module Version
+    MAJOR, MINOR, PATCH = 2, 0, 4
+    STRING              = [MAJOR, MINOR, PATCH].join('.')
+  end
+
+  VERSION = Version::STRING
+end

data/lib/rs_232.rb

@@ -0,0 +1,145 @@
+require "rs_232/version"
+require "rs_232.so"
+
+#== Adapter implementation example, no event only read on-demand:
+#
+#  @usage:
+#
+#  instantiate adapter
+#  +adapter+ = +Serial.new("COM3")+ #=> [Object]
+#
+#  write string
+#  +adapter.tx("Hello, World\n")+ #=> 13
+#
+#  read all available bytes
+#  +adapter.rx(-1)+ #=> "Bye bye cruel world\n"
+#
+#
+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)
+    connect
+    $stdout.puts "*** Rs232 instance has been initialized. Build v#{::Rs232::VERSION}"
+  end
+
+  # Open and configure interface
+  #
+  # @return [Bool]
+  #
+  def connect
+    @interface.open
+    # custom configuration should be there if required
+    # @interface.baud_rate    = BAUD_115200
+    # @interface.data_bits    = DATA_BITS_8
+    # @interface.parity       = PAR_NONE
+    # @interface.stop_bits    = STOP_1
+    # @interface.flow_control = 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

data/rs_232.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rs_232/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rs_232'
+  spec.version       = Rs232::VERSION
+  spec.authors       = ['Roman Lishtaba']
+  spec.email         = ['roman@lishtaba.com']
+  spec.description   = %q{rs-232 lib}
+  spec.summary       = %q{rs-232 lib gem summary}
+  spec.homepage      = 'http://www.lishtaba.com'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['**/*']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.extensions  = %w(ext/rs_232/extconf.rb)
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 0'
+  spec.add_development_dependency 'cucumber', '~> 0'
+  spec.add_development_dependency 'rake-compiler', '~> 0'
+  spec.add_development_dependency 'simplecov', '~> 0'
+  spec.add_development_dependency 'pry', '~> 0'
+
+
+  spec.post_install_message     = <<-MSG
+  **********************************************************
+  *** INFO:                                              ***
+  *** You've installed the binary version of Rs-232 gem! ***
+  *** Bug reports are welcome: [roman@lishtaba.com]      ***
+  *** happy codding!!!                                   ***
+  **********************************************************
+  MSG
+end

data/spec/simplecov_setup.rb

@@ -0,0 +1,15 @@
+begin
+  # Suppress warnings in order not to pollute stdout which tests expectations rely on
+  $VERBOSE = nil if defined?(JRUBY_VERSION)
+
+  require 'simplecov'
+
+  SimpleCov.root(File.expand_path(File.dirname(__FILE__) + '/..'))
+  SimpleCov.start do
+    add_filter '/features/'
+    add_filter '/spec/'
+  end
+
+rescue LoadError
+  warn("Unable to load simplecov gem")
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler'
+require 'bundler/setup'
+require 'rspec'
+require 'rs_232'
+
+Dir[File.expand_path('support/**/*.rb', File.dirname(__FILE__))].each do |f|
+  require f if File.file?(f)
+end
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = :documentation
+end
+
+load File.expand_path '../simplecov_setup.rb', __FILE__

data/spec/support/fixtures.rb

@@ -0,0 +1,23 @@
+require 'pathname'
+
+module Fixtures
+  def fixture_path(name)
+    File.join '../fixtures', name
+  end
+
+  def absolute_fixture_path(name)
+    File.expand_path fixture_path(name), File.dirname(__FILE__)
+  end
+
+  def fixture(name)
+    File.read absolute_fixture_path(name)
+  end
+
+  def binary_fixture(name)
+    File.open(absolute_fixture_path(name), "rb") { |f| f.read }
+  end
+
+  def fixtures_path
+    Pathname(absolute_fixture_path '')
+  end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: rs_232
+version: !ruby/object:Gem::Version
+  version: 2.0.4
+platform: ruby
+authors:
+- Roman Lishtaba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rs-232 lib
+email:
+- roman@lishtaba.com
+executables:
+- env.rb
+extensions:
+- ext/rs_232/extconf.rb
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/env.rb
+- cucumber.yml
+- ext/rs_232/constants.c
+- ext/rs_232/constants.h
+- ext/rs_232/extconf.rb
+- ext/rs_232/initializer.c
+- ext/rs_232/initializer.h
+- ext/rs_232/posix/port.c
+- ext/rs_232/posix/port.h
+- ext/rs_232/structs.h
+- ext/rs_232/windows/port.c
+- ext/rs_232/windows/port.h
+- features/config/config.yml
+- features/connection.feature
+- features/step_definitions/connection_steps.rb
+- features/support/adapter.rb
+- features/support/adapter/dev.rb
+- features/support/adapter/generic.rb
+- features/support/adapter/rs_logger.rb
+- features/support/after.rb
+- features/support/env.rb
+- gem_tasks/cov.rake
+- gem_tasks/cucumber.rake
+- gem_tasks/doc.rake
+- gem_tasks/environment.rake
+- gem_tasks/rspec.rake
+- lib/rs_232.rb
+- lib/rs_232/version.rb
+- rs_232.gemspec
+- spec/simplecov_setup.rb
+- spec/spec_helper.rb
+- spec/support/fixtures.rb
+homepage: http://www.lishtaba.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: |2
+    **********************************************************
+    *** INFO:                                              ***
+    *** You've installed the binary version of Rs-232 gem! ***
+    *** Bug reports are welcome: [roman@lishtaba.com]      ***
+    *** happy codding!!!                                   ***
+    **********************************************************
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: rs-232 lib gem summary
+test_files:
+- features/config/config.yml
+- features/connection.feature
+- features/step_definitions/connection_steps.rb
+- features/support/adapter.rb
+- features/support/adapter/dev.rb
+- features/support/adapter/generic.rb
+- features/support/adapter/rs_logger.rb
+- features/support/after.rb
+- features/support/env.rb
+- spec/simplecov_setup.rb
+- spec/spec_helper.rb
+- spec/support/fixtures.rb