ruble 0.0.3.alpha

data/lib/tasks/dev/pager.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'shellwords'
+require 'pathname'
+require 'concurrent-ruby'
+
+Thread.report_on_exception = true
+
+class Pager
+  # INSTANCE_LOCK = Mutex.new
+  LOCK_LOCAL = Concurrent::ThreadLocalVar.new
+  private_constant :LOCK_LOCAL
+  #noinspection RubyArgCount
+  INSTANCE_USE_COUNT = Concurrent::Semaphore.new(1)
+  CMD = %W[less -FXeR]
+
+  class << self
+    def reset_fds!
+      STDERR.reopen REAL_STDERR
+      STDOUT.reopen REAL_STDOUT
+    end
+
+    def atom
+      @atom ||= Concurrent::AtomicReference.new
+    end
+
+    private :new
+    def instance
+      return atom.get if atom.get
+
+      atom.update do |current|
+        next current if current
+
+        @instance = new
+      end
+    end
+
+    def reset = atom.update { false }
+  end
+
+  attr_reader *%i[cmdline pid status started_at finished_at duration waiter _lock]
+
+  # def set_as_singleton_instance!(...) =
+  # def unset_as_singleton_instance!(...) = @lock.unlock!(...)
+
+  def initialize
+    # @lock = Concurrent::ReentrantReadWriteLock.new
+    @mtx = Mutex.new
+    # @guard = LockGuard.new
+    # @_lock = Concurrent::ReentrantReadWriteLock.new
+    # @guards = Concurrent::ThreadLocalVar.new
+    @cmdline = CMD.shelljoin.freeze
+    @status = nil
+  end
+
+  # def guard
+  #   @guard
+  #   # @guards.value ||= LockGuard.new(@_lock, type: :write)
+  # end
+
+  # def lock
+  #   LOCK_LOCAL.value ||= LockGuard.new(INSTANCE_LOCK)
+  # end
+  def io = @in
+  def started? = !!started_at
+  def finished? = !!finished_at
+  def alive? = pid && Process.kill(0, pid)
+  def status? = !!status
+
+  def start
+    return
+    raise "Pager already stopped. You need to create a new instance" if finished?
+    return self if @waiter
+
+    @mtx.synchronize do
+      return self if @waiter
+
+      @out, @in = IO.pipe
+      [@out, @in].each { _1.sync = true }
+      @waiter ||= Thread.new { _pager! }
+    end
+    self
+  end
+
+  def wait!
+    return status if status?
+    raise "Pager is not running. Nothing to wait for." unless @waiter
+
+    @waiter.join
+    status
+  end
+
+  def close!(ignore_repeats: false)
+    # lck = guard.lock(ignore_repeats: ignore_repeats)
+    @mtx.synchronize do
+      self.class.reset_fds!
+      io&.close unless io&.closed?
+    end
+  end
+
+  # def stop!(wait: true)
+  #   close!
+  #   Process.kill(:SIGTERM, pid) if alive? # TODO: kill if we don't shutdown cleanly?
+  #   wait! if wait
+  # end
+
+  def use(&block)
+    start
+    @mtx.synchronize(&block)
+  rescue
+    # stop!
+    raise
+  end
+
+  def eval_paginated(&block)
+    use do
+      @real_stdout = STDOUT.dup
+      @real_stderr = STDERR.dup
+      STDOUT.reopen io
+      STDERR.reopen io
+      block.yield self
+    ensure
+      STDOUT.reopen @real_stdout
+      STDERR.reopen @real_stderr
+      self.class.reset_fds!
+    end
+  end
+
+  #noinspection RbsMissingTypeSignature
+  def exec_unpaginated!(cmdargs, *args, chdir: ROOT_PATH, allow_fail: false, env: {}, **kwargs)
+    status = nil
+    out = String.new
+    err = String.new
+    rout, wout = IO.pipe
+    rerr, werr = IO.pipe
+    Bundler.with_unbundled_env do
+      cmd = cmdargs.is_a?(Array) ? cmdargs.shelljoin : cmdargs
+      puts "Running: #{cmd} in directory #{chdir}"
+      pid = Process.spawn(env, cmd, *args, **kwargs, chdir: chdir.to_s, in: File.open(OS.dev_null, 'wt'), out: wout, err: werr)
+      [wout, werr].each(&:close)
+      result = nil
+      open_ios = [rout, rerr]
+      close_io = ->(io) { io.close unless io.closed?; open_ios.delete(io) }
+
+      until (result ||= Process.wait2(pid, Process::WNOHANG)) || open_ios.empty?
+        rd_io, _, err_io = IO.select(open_ios, [], open_ios, 5)
+        err_io&.each { |io| close_io[io] }
+        rd_io&.each do |io|
+          next close_io[io] if io.eof? || io.closed?
+
+          buf = io == rout ? out : err
+          buf << io.read_nonblock(8192)
+        end
+      end
+
+      open_ios.each do |io|
+        buf = io == rout ? out : err
+        until io.closed? || io.eof?
+          buf << io.read_nonblock(8192)
+        end
+        io.close unless io.closed?
+      end
+
+      result ||= Process.wait2(pid)
+      _, status = result
+
+      unless status.success? && !allow_fail
+        STDERR.puts "Execution of #{cmd.inspect} failed with code #{status.inspect}.\n"\
+                    "Output:\n#{out}\nError:\n#{err}"
+        exit(status.exitstatus.to_i)
+      end
+    end
+    [status, out, err]
+  end
+
+  #noinspection RbsMissingTypeSignature
+  def exec_paginated!(cmdargs, *args, chdir: ROOT_PATH, env: {}, **kwargs)
+    status = nil
+    use do
+      Bundler.with_unbundled_env do
+        cmd = cmdargs.is_a?(Array) ? cmdargs.shelljoin : cmdargs
+        puts "Running: #{cmd} in directory #{chdir}"
+        pid = Process.spawn(env, cmd, *args, **kwargs, chdir: chdir.to_s)
+        _, status = Process.wait2(pid)
+
+        unless status.success?
+          STDERR.puts "Execution of #{cmd.inspect} failed with code #{status.inspect}"
+          exit(status.exitstatus.to_i)
+        end
+      end
+    end
+    status
+  end
+
+private
+  def _pager!
+    Thread.current.abort_on_exception = true
+    Thread.current.report_on_exception = true
+
+    @pid = Process.fork
+
+    unless @pid
+      @in.close
+      STDIN.reopen(@out)
+      Process.exec(cmdline)
+    end
+
+    @out.close
+    @started_at ||= Time.now
+    at_exit { wait! }
+    _, @status = Process.wait2(@pid)
+
+    @finished_at = Time.now
+    @duration = @finished_at - @started_at
+    status
+  end
+end

data/lib/tasks/dev/paths.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'rbconfig'
+require_relative '../../ruble/build'
+
+module Paths
+  class << self
+    include RuBLE::Build::Data::Extension
+  end
+
+  GEM_NAME = Paths.gem_name
+  EXTENSION_NAME = GEM_NAME.downcase
+  ROOT_DIR = Paths.gem_full_path.cleanpath(false)
+  TMP_DIR = ROOT_DIR / 'tmp'
+  EXT_DIR = ROOT_DIR / 'ext' / EXTENSION_NAME
+  TEST_DIR = ROOT_DIR / 'test'
+  LIB_DIR = ROOT_DIR / 'lib' / GEM_NAME.downcase
+  LIB_FILE = LIB_DIR / "#{EXTENSION_NAME}.so"
+  BUILD_LIBS_DIR = LIB_DIR / 'build'
+  BUILD_DIR = TMP_DIR / RbConfig::MAKEFILE_CONFIG['arch'] /
+    EXTENSION_NAME / RbConfig::CONFIG['RUBY_PROGRAM_VERSION']
+  EXT_DIR_FROM_BUILD_DIR = EXT_DIR.relative_path_from(BUILD_DIR)
+  BUILD_INFO_FILE = BUILD_DIR / 'build-config.cmake'
+  NINJA_FILE = BUILD_DIR / 'build.ninja'
+  HASH_FILE = BUILD_DIR / '.state_hash'
+  SRC_GLOB = '{**/,}*.{{h,c}{,pp},ipp}'
+  OBJFILES_DIR = BUILD_DIR / 'CMakeFiles' / "#{EXTENSION_NAME}.dir"
+  CMAKE_CXX_COMPILER = '/usr/bin/g++-13'
+end

data/lib/tasks/dev/state_hash.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+require_relative 'paths'
+
+module StateHash
+  READ_BUFFER_SIZE = 8192
+  
+  def hash_file(path, digest: 'SHA256')
+    hasher = OpenSSL::Digest.new(digest.to_s)
+    File.open(path.to_s, 'rb') do |f|
+      hasher << f.readpartial(READ_BUFFER_SIZE) until f.eof?
+    end
+    hasher.hexdigest
+  rescue RefError # TODO: catch file not found errors (this is placeholder)
+    nil
+  end
+
+  def watched_files = [
+    *basic_gem_files,
+    *build_libs_files,
+    *cmake_files,
+    *build_output_files,
+  # TODO(?): Include lib/tasks/dev/*.rb
+  ].select(&:file?)
+
+  def watched_file_hashes = watched_files.to_h do
+    [_1, hash_file(_1)]
+  end
+
+  def state_hash
+    fields = [
+      watched_file_hashes
+    ]
+
+    JSON.pretty_generate(fields)
+  end
+
+private
+
+  def basic_gem_files = [
+    Paths::ROOT_DIR / '.ruby-version',
+    Paths::ROOT_DIR / 'Gemfile',
+    Paths::ROOT_DIR / 'Gemfile.lock',
+    *Paths::ROOT_DIR.glob('*.gemspec'),
+    Paths::ROOT_DIR / 'Rakefile',
+  ]
+
+  def build_libs_files = [
+    Paths::BUILD_LIBS_DIR.sub_ext('.rb'),
+    *Paths::BUILD_LIBS_DIR.glob('*.rb'),
+    *Paths::BUILD_LIBS_DIR.glob('**/*.rb')
+  ]
+
+  def cmake_files = [
+    Paths::EXT_DIR / 'extconf.rb',
+    Paths::EXT_DIR / 'CMakeLists.txt',
+    *Paths::EXT_DIR.glob('*.cmake'),
+  ]
+
+  def build_output_files = [
+    Paths::BUILD_INFO_FILE,
+    Paths::NINJA_FILE,
+    Paths::BUILD_DIR / 'CMakeCache.txt',
+    Paths::BUILD_DIR / 'config.h',
+  ]
+end

data/lib/tasks/dev.rake

@@ -0,0 +1,41 @@
+namespace :dev do
+  task :initialize, %i[flags] do |task, args|
+    # Bundler.require
+    Bundler.setup
+    require_relative './dev/dev_tasks'
+    flags = (args.flags || '').split(/,\s*/).each(&:strip!).reject(&:empty?).map(&:to_sym).to_set
+    @devTasks = DevTasks.new(*flags)
+  end
+  desc 'Cleans/Clobbers all generated files'
+  task :pristine, %i[flags] do |task, args|
+    Rake::Task['dev:initialize'].invoke(args.flags)
+    @devTasks.pristine!
+  end
+
+  desc 'Cleans/Clobbers, generates Makefiles/etc before build'
+  task :reconfigure, %i[flags] do |task, args|
+    Rake::Task['dev:initialize'].invoke(args.flags)
+    @devTasks.reconfigure!
+  end
+
+  desc 'Reconfigures only if needed'
+  task :maybe_reconfigure, %i[flags] do |task, args|
+    Rake::Task['dev:initialize'].invoke(args.flags)
+    @devTasks.maybe_reconfigure!
+  end
+
+  desc 'Compiles code for debugging'
+  task :build, %i[flags] do |task, args|
+    Rake::Task['dev:initialize'].invoke(args.flags)
+    @devTasks.build!
+  end
+
+  desc 'Audit missing symbols in built object files'
+  task :audit_objfile_symbols, %i[flags]  do |task, args|
+    Rake::Task['dev:initialize'].invoke(args.flags)
+    @devTasks.audit_objfile_symbols!
+  end
+end
+task(:dev, %i[flags]) { |task, args| Rake::Task['dev:build'].invoke(args.flags) }
+
+task audit_objfile_symbols: %i[dev:audit_objfile_symbols]

data/lib/tasks/simpleble.rake

@@ -0,0 +1,29 @@
+desc 'Fetch SimpleBLE release'
+namespace :SimpleBLE do
+  task :initialize, %i[release] do |task, args|
+    opts = { tag: args.release }.compact
+
+    require_relative '../ruble/build/simpleble'
+    @simpleble = SimpleBLE.new(**opts)
+  end
+
+  task info: %i[initialize] do
+    pp @assets = @simpleble.assets
+    pp @asset = @simpleble.matching_asset
+    pp @url = @simpleble.download_url
+    pp @hash = @simpleble.download_md5_checksum
+  end
+
+  task download: %i[initialize] do
+    @simpleble.download!
+  end
+
+  task extract: %i[download] do
+    @simpleble.extract!
+  end
+
+  task install: %i[extract] do
+    @simpleble.install!
+  end
+end
+

data/sig/rubble.rbs

@@ -0,0 +1,4 @@
+module RuBLE
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,263 @@
+--- !ruby/object:Gem::Specification
+name: ruble
+version: !ruby/object:Gem::Version
+  version: 0.0.3.alpha
+platform: ruby
+authors:
+- Mike Vastola
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.12
+- !ruby/object:Gem::Dependency
+  name: rice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.11
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: memery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: RuBLE is a ruby interface to the SimpleBLE library, providing a cross-platform
+  DSL for interacting with Bluetooth Low Energy (BLE) devices.
+email:
+- Mike@Vasto.la
+executables: []
+extensions:
+- ext/ruble/extconf.rb
+extra_rdoc_files:
+- "./CHANGELOG.md"
+- "./CODE_OF_CONDUCT.md"
+- "./README.md"
+files:
+- "./CHANGELOG.md"
+- "./CODE_OF_CONDUCT.md"
+- "./README.md"
+- ".gdbinit"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CMakeLists.txt
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/ruble/.gitignore
+- ext/ruble/CMakeLists.txt
+- ext/ruble/RuBLEHelpers.cmake
+- ext/ruble/bindings/Adapter.cpp
+- ext/ruble/bindings/Adapter.hpp
+- ext/ruble/bindings/Characteristic.cpp
+- ext/ruble/bindings/Characteristic.hpp
+- ext/ruble/bindings/Descriptor.cpp
+- ext/ruble/bindings/Descriptor.hpp
+- ext/ruble/bindings/Peripheral.cpp
+- ext/ruble/bindings/Peripheral.hpp
+- ext/ruble/bindings/RuBLE.cpp
+- ext/ruble/bindings/Service.cpp
+- ext/ruble/bindings/Service.hpp
+- ext/ruble/bindings/common.hpp
+- ext/ruble/bindings/globals.cpp
+- ext/ruble/cmake.mk
+- ext/ruble/concerns/CharacteristicValueTracker.cpp
+- ext/ruble/concerns/CharacteristicValueTracker.hpp
+- ext/ruble/concerns/Rubyable.cpp
+- ext/ruble/concerns/Rubyable.hpp
+- ext/ruble/config.h.in
+- ext/ruble/containers/ByteArray.cpp
+- ext/ruble/containers/ByteArray.hpp
+- ext/ruble/containers/Callback.hpp
+- ext/ruble/containers/NamedBitSet.hpp
+- ext/ruble/containers/NamedBitSet.ipp
+- ext/ruble/extconf.rb
+- ext/ruble/management/Registry.cpp
+- ext/ruble/management/Registry.hpp
+- ext/ruble/management/RegistryFactory.hpp
+- ext/ruble/management/RubyQueue.cpp
+- ext/ruble/management/RubyQueue.hpp
+- ext/ruble/modularize.diff
+- ext/ruble/types/SimpleBLE.hpp
+- ext/ruble/types/declarations.hpp
+- ext/ruble/types/helpers.hpp
+- ext/ruble/types/ruby.hpp
+- ext/ruble/types/stl.hpp
+- ext/ruble/utils/RubyCallbackTraits.cpp
+- ext/ruble/utils/RubyCallbackTraits.hpp
+- ext/ruble/utils/async.cpp
+- ext/ruble/utils/async.hpp
+- ext/ruble/utils/containers.hpp
+- ext/ruble/utils/exception_handling.cpp
+- ext/ruble/utils/exception_handling.hpp
+- ext/ruble/utils/garbage_collection.cpp
+- ext/ruble/utils/garbage_collection.hpp
+- ext/ruble/utils/hash.cpp
+- ext/ruble/utils/hash.hpp
+- ext/ruble/utils/hexadecimal.hpp
+- ext/ruble/utils/human_type_names.hpp
+- ext/ruble/utils/inspection.cpp
+- ext/ruble/utils/inspection.hpp
+- ext/ruble/utils/ruby.hpp
+- ext/ruble/utils/ruby_context.hpp
+- lib/ruble.rb
+- lib/ruble/build.rb
+- lib/ruble/build/.rubocop.yml
+- lib/ruble/build/boost.rb
+- lib/ruble/build/cmake.rb
+- lib/ruble/build/core_ext.rb
+- lib/ruble/build/data.rb
+- lib/ruble/build/data/bundler.rb
+- lib/ruble/build/data/extension.rb
+- lib/ruble/build/data/os.rb
+- lib/ruble/build/data/rice.rb
+- lib/ruble/build/extconf.rb
+- lib/ruble/build/github_repo.rb
+- lib/ruble/build/simpleble.rb
+- lib/ruble/version.rb
+- lib/tasks/dev.rake
+- lib/tasks/dev/dev_tasks.rb
+- lib/tasks/dev/pager.rb
+- lib/tasks/dev/paths.rb
+- lib/tasks/dev/state_hash.rb
+- lib/tasks/simpleble.rake
+- sig/rubble.rbs
+homepage: https://github.com/mvastola/RuBLE
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mvastola/RuBLE
+  bug_tracker_uri: https://github.com/mvastola/RuBLE/issues
+  source_code_uri: https://github.com/mvastola/RuBLE
+  changelog_uri: https://github.com/mvastola/RuBLE/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/RuBLE
+  rubygems_mfa_required: 'true'
+  boost_library_release_tag: boost-1.83.0
+  simpleble_library_release_tag: v0.6.1
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements:
+- C++ compiler supporting standard c++23 (e.g. g++-13)
+- CMake version 3.25.1 or higher
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Ru(by Simple)BLE library
+test_files: []