c-dependencies 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4710ae38237a141810ec0bfab78b5a00f7f19f74
+  data.tar.gz: c21b6ab27d7456536c22ff292278dece6e15da53
+SHA512:
+  metadata.gz: c641b8d87f6596e3a48b53bcb9f8e7208aa4fe025cbf22873a7afcd9f50f0e000a5802514f8c2d1c8fee7a51688fb9108f6428a9c96d48d57755e7cd5d864f05
+  data.tar.gz: 8eb08801174891763d9705852888429a9cab76de56e279ca44bab9c26b1b239bff89a7eb4a25fe6fbfa1b8ddf988b79e6bf05bd1c33fa8236e2d916de9bb6279

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.rbenv-gemsets

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in c-dependencies.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    c-dependencies (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.4.3)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  c-dependencies!
+  minitest
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.10.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,24 @@
+# CDependencies
+
+Simple gem to help discover and work with C/C++/ASM file dependencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'c-dependencies'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install c-dependencies
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "c-dependencies"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/c-dependencies.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'c-dependencies/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'c-dependencies'
+  spec.version       = CDependencies::VERSION
+  spec.authors       = ['Matt Massicotte']
+
+  spec.summary       = 'Manage C/C++ file dependencies with Ruby'
+  spec.homepage      = 'https://github.com/mattmassicotte/c-dependencies'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/c-dependencies/compiler_invocation.rb

@@ -0,0 +1,59 @@
+module CDependencies
+  class FileUnsupportedError < StandardError
+  end
+
+  class CompilerInvocation
+    attr_accessor :tool_name
+    attr_accessor :flags
+    attr_accessor :input_path
+    attr_accessor :output_file
+    attr_accessor :output_path
+
+    EXTENSION_MAP = { '.c' => 'cc',
+                      '.cc'=> 'c++',
+                      '.cpp' => 'c++',
+                      '.hpp' => 'c++',
+                      '.S' => 'gas',
+                      '.asm' => 'nasm' }
+
+    def initialize(path, compiler_flags=nil)
+      self.input_path = path
+      self.flags = compiler_flags
+
+      if tool_name.nil?
+        raise FileUnsupportedError.new("Unsure how to compile a file with extension '#{input_extension}'")
+      end
+    end
+
+    def input_extension
+      File.extname(input_path)
+    end
+
+    def tool_name
+      EXTENSION_MAP[input_extension]
+    end
+
+    def dependency_cmd
+      "#{tool_cmd} #{dependency_flag} '#{input_path}'"
+    end
+
+    def has_flags?
+      !flags.nil? && flags != ''
+    end
+
+    private
+    def tool_cmd
+      has_flags? ? "#{tool_name} #{flags}" : tool_name
+    end
+
+    def dependency_flag
+      case tool_name
+      when 'cc', 'c++'
+        # -MM suppresses system header dependencies
+        '-MM'
+      when 'nasm'
+        '-M'
+      end
+    end
+  end
+end

data/lib/c-dependencies/dependency_list.rb

@@ -0,0 +1,41 @@
+require 'digest'
+
+module CDependencies
+  class DependencyList
+    attr_reader :paths
+
+    def initialize(array)
+      @paths = array.map { |x| File.absolute_path(x) }
+    end
+
+    def write_to_file(path)
+      File.open(path, 'w+') do |file|
+        file << serializable_entries.join("\n")
+        file << "\n"
+      end
+    end
+
+    def self.read_from_file(path)
+      list = File.readlines(path)
+      list.map! { |x| x.chomp() }
+
+      # make a non-empty list of files that also exist
+      list.reject! { |x| x.empty? || !File.exist?(x) }
+
+      DependencyList.new(list)
+    end
+
+    private
+    def serializable_dependency_entry(entry)
+      entry
+    end
+
+    def serializable_entries
+      paths.map { |x| serializable_dependency_entry(x) }
+    end
+
+    def file_hash(path)
+      Digest::SHA1.file(path).hexdigest
+    end
+  end
+end

data/lib/c-dependencies/version.rb

@@ -0,0 +1,3 @@
+module CDependencies
+  VERSION = "0.1.0"
+end

data/lib/c-dependencies.rb

@@ -0,0 +1,29 @@
+require "c-dependencies/version"
+require 'c-dependencies/compiler_invocation'
+require 'c-dependencies/dependency_list'
+
+module CDependencies
+  def self.for_source_file(path, flags=nil)
+    invocation = CompilerInvocation.new(path, flags)
+
+    cmd = invocation.dependency_cmd
+
+    # consult rake's verbose function, if defined
+    if defined? verbose
+      puts(cmd) if verbose()
+    end
+
+    output = `#{cmd}`.chomp()
+    list = output.split()
+    raise("unexpected dependency output for '#{path}'") if list.size < 2
+
+    # remove blanks and line continuations, which can come up as a side-effect
+    # of the split
+    list.reject! { |x| x.empty? || x == '\\' }
+
+    # first element is the object file, second is the source itself
+    list = list[2..-1]
+
+    DependencyList.new(list)
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: c-dependencies
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Massicotte
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- c-dependencies.gemspec
+- lib/c-dependencies.rb
+- lib/c-dependencies/compiler_invocation.rb
+- lib/c-dependencies/dependency_list.rb
+- lib/c-dependencies/version.rb
+homepage: https://github.com/mattmassicotte/c-dependencies
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Manage C/C++ file dependencies with Ruby
+test_files: []