steamd 0.1.0

data/lib/steamd/parser.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+require 'treetop'
+require 'steamd/nodes/nodes'
+
+module Steamd
+  # Parses steam language files. Give access to the parsed data
+  # via #classes, #imports and #enums methods.
+  #
+  # @example Parsing a Steam Language file
+  #   parser = Parser.new
+  #   parser.load! # loads the grammars, sets up the parser
+  #   parser.parse(File.open('./message.steamd'))
+  class Parser
+    # The base Parser error
+    Error = Class.new(StandardError)
+
+    # Thrown if there was any non specific Parse error.
+    ParseError = Class.new(Error)
+
+    # Thrown if the the parse method is called before the parser is loaded
+    NotLoadedError = Class.new(Error)
+
+    # Thrown if the callee tries to access the parsed data before parse is
+    # called
+    StreamNotParsed = Class.new(Error)
+
+    # Load the grammars
+    #
+    # @return [Bool] returns true unless an exception is thrown
+    def load!
+      return if loaded?
+
+      Treetop.load("#{Steamd.grammar_dir}/shared.treetop")
+
+      Dir.glob("#{Steamd.grammar_dir}/*.treetop") do |file|
+        Treetop.load(file)
+      end
+
+      @parser = SteamdParser.new
+      true
+    end
+
+    # Parses an IO stream.
+    #
+    # @param io [#read, #rewind] An IO stream containing the Steam Language
+    #   data.
+    # @return [Bool] returns true unless an error is thrown
+    def parse(io)
+      io.rewind
+      raise NotLoadedError, 'load before parsing (#load!)' if @parser.nil?
+
+      data = strip_comments_and_obsolete_tags!(io)
+
+      @tree = @parser.parse(data)
+      raise_parser_error! if @tree.nil?
+
+      true
+    end
+
+    # An array of hashes containing the imports found in the parsed
+    # Steam Language file.
+    #
+    # The hash is the hash version of ImportStatement
+    #
+    # @example Accessing imports
+    #   parser.imports # => [{filename: 'test'}]
+    #
+    # @return [Array<Hash>] an array of hashes representing the imports found
+    # @see ImportStatement
+    def imports
+      raise StreamNotParsed, 'you must parse first' if @tree.nil?
+
+      imports = statements.select do |node|
+        node.is_a?(ImportStatement)
+      end
+
+      imports.map(&:to_hash)
+    end
+
+    # Returns an array of classes parsed from the IO stream. The array
+    # contains hashes with class information and variables.
+    #
+    # The hash is the hash form of ClassStatement
+    #
+    # @example Accessing the classes
+    #   parser.classes # => [{ name: 'test', variables: [], ...]
+    #
+    # @return [Array<Hash>] an array of hashes representing the class
+    # @see ClassStatement
+    def classes
+      raise StreamNotParsed, 'you must parse first' if @tree.nil?
+
+      classes = statements.select do |node|
+        node.is_a?(ClassStatement)
+      end
+
+      classes.map(&:to_hash)
+    end
+
+    # Returns an array of eneums parsed from the IO stream. The array
+    # contains hashes with enum information and variables.
+    #
+    # The hash is the hash form of EnumStatement
+    #
+    # @example Accessing the enums
+    #   parser.enums # => [{ name: 'test', variables: [], ...]
+    #
+    # @return [Array<Hash>] an array of hashes representing the class
+    # @see EnumStatement
+    def enums
+      raise StreamNotParsed, 'you must parse first' if @tree.nil?
+
+      enums = statements.select do |node|
+        node.is_a?(EnumStatement)
+      end
+
+      enums.map(&:to_hash)
+    end
+
+    # Returns a hash representing the reason the parser failed.
+    #
+    # @example
+    #   parser.last_error # => { reason: "Missing ';'", column: 1, line: 12 }
+    def last_error
+      {
+        reason: @parser.failure_reason,
+        column: @parser.failure_column,
+        line: @parser.failure_line
+      }
+    end
+    alias error last_error
+
+    private
+
+    # @api private
+    def loaded?
+      !@parser.nil?
+    end
+
+    # @api private
+    def statements
+      @tree.statements
+    end
+
+    # @api private
+    def raise_parser_error!
+      raise ParseError, "Parsing failed: #{error[:reason]} "\
+                              "(col: #{error[:column]}, ln: #{error[:line]}"
+    end
+
+    # Fully reads the IO stream, and removes all comments
+    # and obsolete tags
+    def strip_comments_and_obsolete_tags!(io)
+      io.read.strip.gsub(%r{\/\/.*}, '').gsub(/\;\s?obsolete.*/, ';')
+    end
+  end
+end

data/lib/steamd/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Steamd
+  # Major version of Steamd
+  MAJOR = '0'
+
+  # Minor version of Steamd
+  MINOR = '1'
+
+  # Patch version of Steamd
+  PATCH = '0'
+
+  # Full version of Steamd
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
+end

data/steamd.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'steamd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'steamd'
+  spec.version       = Steamd::VERSION
+  spec.authors       = ['Taylor Finnell']
+  spec.email         = ['tmfinnell@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Ruby access to the Steam Language.'
+
+  spec.description   = 'Generate Ruby code for the full Steam Language.'\
+                          ' Useful for Steam clients'
+
+  spec.homepage      = 'http://github.com/fastpeek/steamd'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = ['steamd']
+  spec.require_paths = ['lib', 'ext']
+
+  spec.required_ruby_version = '>= 2.3.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'pry',     '~> 0.10.4'
+  spec.add_development_dependency 'rubocop', '~> 0.44.1'
+  spec.add_development_dependency 'yard',    '~> 0.9.5'
+  spec.add_development_dependency 'thor',    '~> 0.19.1'
+  spec.add_development_dependency 'treetop', '~> 1.6'
+end

data/tasks/language.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+namespace :language do
+  desc 'Update the language files from the SteamKit repository.'
+  task :update do
+    Dir.mktmpdir do |path|
+      `git clone https://github.com/SteamRE/SteamKit.git #{path} --depth=1`
+
+      `cp -r #{path}/Resources/SteamLanguage/*.steamd #{Steamd.language_dir}/.`
+    end
+  end
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: steamd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taylor Finnell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Generate Ruby code for the full Steam Language. Useful for Steam clients
+email:
+- tmfinnell@gmail.com
+executables:
+- steamd
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/steamd
+- grammar/class.treetop
+- grammar/enums.treetop
+- grammar/import.treetop
+- grammar/shared.treetop
+- grammar/steamd.treetop
+- language/emsg.steamd
+- language/enums.steamd
+- language/eresult.steamd
+- language/gamecoordinator.steamd
+- language/header.steamd
+- language/netheader.steamd
+- language/steammsg.steamd
+- lib/ext/string.rb
+- lib/steamd.rb
+- lib/steamd/cli.rb
+- lib/steamd/cli_options.rb
+- lib/steamd/code_generator.rb
+- lib/steamd/generated/emsg.rb
+- lib/steamd/generated/enums.rb
+- lib/steamd/generated/eresult.rb
+- lib/steamd/generated/gamecoordinator.rb
+- lib/steamd/generated/header.rb
+- lib/steamd/generated/netheader.rb
+- lib/steamd/generated/steammsg.rb
+- lib/steamd/generator.rb
+- lib/steamd/generator/generated_class.rb
+- lib/steamd/generator/generated_enum.rb
+- lib/steamd/generator/generated_import.rb
+- lib/steamd/generator/implementation.rb
+- lib/steamd/generator/ruby/class.erb
+- lib/steamd/generator/ruby/enum.erb
+- lib/steamd/generator/ruby/import.erb
+- lib/steamd/generator/ruby/ruby.rb
+- lib/steamd/generator/ruby/serializable_constant.rb
+- lib/steamd/generator/ruby/serializable_type.rb
+- lib/steamd/generator/ruby/serializable_variable.rb
+- lib/steamd/generator/ruby/steam_serializable.rb
+- lib/steamd/nodes/block_node.rb
+- lib/steamd/nodes/class_statement_node.rb
+- lib/steamd/nodes/class_type_node.rb
+- lib/steamd/nodes/enum_statement_node.rb
+- lib/steamd/nodes/enum_variable_node.rb
+- lib/steamd/nodes/import_statement_node.rb
+- lib/steamd/nodes/node.rb
+- lib/steamd/nodes/nodes.rb
+- lib/steamd/nodes/variable_node.rb
+- lib/steamd/parser.rb
+- lib/steamd/version.rb
+- steamd.gemspec
+- tasks/language.rake
+homepage: http://github.com/fastpeek/steamd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby access to the Steam Language.
+test_files: []