rubygems-xcodeproj_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd3609d33811ffcb5a33d2d07760c8aa9326c3cb
+  data.tar.gz: 584c86d0d89645c67f09a7bed9b733b70bdb7d78
+SHA512:
+  metadata.gz: dfe55460bf96d1212f3add1456be6e478253b1da2b74c16320b999d9ffe3cb4d83f513f8d703fee69b297d2538c4b1beccad726d32c563b4a33e09e6aa9b2798
+  data.tar.gz: 39fc8422f176f284d93c663c15cd1fd97e73455dcf1e9902456214ad882ec6bcf36533e21b4a78aa9c15d3bc71065eadf17aef181f32d0a328a4e26d7917f827

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Metrics/LineLength:
+  Max: 100
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: separator
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Exclude:
+    - '*.gemspec'
+    - 'Guardfile'

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+script: bundle exec rake ci
+sudo: false
+cache: bundler

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 10.0'
+  gem 'rspec', '~> 3.2'
+  gem 'rubocop', '~> 0.29'
+  gem 'simplecov', '~> 0.9'
+end
+
+group :test do
+  gem 'coveralls', '~> 0.7'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Yuji Nakayama
+
+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,55 @@
+[![Gem Version](http://img.shields.io/gem/v/rubygems-xcodeproj_generator.svg?style=flat)](http://badge.fury.io/rb/rubygems-xcodeproj_generator)
+[![Dependency Status](http://img.shields.io/gemnasium/yujinakayama/rubygems-xcodeproj_generator.svg?style=flat)](https://gemnasium.com/yujinakayama/rubygems-xcodeproj_generator)
+[![Build Status](https://travis-ci.org/yujinakayama/rubygems-xcodeproj_generator.svg?branch=master&style=flat)](https://travis-ci.org/yujinakayama/rubygems-xcodeproj_generator)
+[![Coverage Status](http://img.shields.io/coveralls/yujinakayama/rubygems-xcodeproj_generator/master.svg?style=flat)](https://coveralls.io/r/yujinakayama/rubygems-xcodeproj_generator)
+[![Code Climate](https://img.shields.io/codeclimate/github/yujinakayama/rubygems-xcodeproj_generator.svg?style=flat)](https://codeclimate.com/github/yujinakayama/rubygems-xcodeproj_generator)
+
+# Rubygems::XcodeprojGenerator
+
+Provides a Rake task for generating an Xcode project for C extension development.
+
+Within the generated Xcode project:
+
+* Code completion is enabled, including Ruby internal functions and macros.
+* You can build the extension by running **⌘B**, though this is just for checking while development and not for production release.
+
+## Basic Usage
+
+Add the following development dependencies to your extension's Gemfile or gemspec:
+
+```ruby
+gem 'rake-compiler'
+gem 'rubygems-xcodeproj_generator'
+```
+
+And execute:
+
+```bash
+$ bundle install
+```
+
+Then add the following code to your Rakefile:
+
+```ruby
+require 'rake/extensiontask'
+require 'rubygems/xcodeproj_generator/rake_task'
+
+Rake::ExtensionTask.new('your-comple-task-name')
+
+Rubygems::XcodeprojGenerator::RakeTask.new do |project|
+  project.name = 'your-xcode-project-name'
+  project.build_command = 'bundle exec rake your-comple-task-name'
+end
+```
+
+And run:
+
+```bash
+$ bundle exec rake generate_xcode_project
+```
+
+## License
+
+Copyright (c) 2015 Yuji Nakayama
+
+See the [LICENSE.txt](LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.verbose = false
+end
+
+RuboCop::RakeTask.new(:style)
+
+task ci: [:spec, :style]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rubygems/xcodeproj_generator'
+
+# 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/lib/rubygems/xcodeproj_generator.rb

@@ -0,0 +1,7 @@
+require 'rubygems/xcodeproj_generator/version'
+
+module Rubygems
+  module XcodeprojGenerator
+    # Your code goes here...
+  end
+end

data/lib/rubygems/xcodeproj_generator/abstract_ruby_header_provider.rb

@@ -0,0 +1,35 @@
+module Rubygems
+  module XcodeprojGenerator
+    class AbstractRubyHeaderProvider
+      attr_reader :root_path
+
+      def initialize(root_path)
+        @root_path = File.expand_path(root_path)
+      end
+
+      def available?
+        Dir.exist?(root_path)
+      end
+
+      def ruby_header_paths
+        [base_ruby_header_path, platform_ruby_header_path].compact
+      end
+
+      private
+
+      def base_ruby_header_path
+        fail NotImplementedError
+      end
+
+      def platform_ruby_header_path
+        return nil unless base_ruby_header_path
+        find_path(base_ruby_header_path, '*darwin*')
+      end
+
+      def find_path(*parts)
+        pattern = File.join(*parts)
+        Dir[pattern].first
+      end
+    end
+  end
+end

data/lib/rubygems/xcodeproj_generator/project.rb

@@ -0,0 +1,98 @@
+require 'xcodeproj'
+require 'rubygems/xcodeproj_generator/rbenv'
+require 'rubygems/xcodeproj_generator/xcode'
+
+module Rubygems
+  module XcodeprojGenerator
+    class Project
+      attr_accessor :name, :build_command
+
+      def initialize(name = nil)
+        @name = name
+      end
+
+      def path
+        project.path
+      end
+
+      def save
+        configure_header_search_paths
+        configure_groups
+        configure_build_phase
+        project.save
+      end
+
+      private
+
+      def project
+        @project ||= Xcodeproj::Project.new("#{name}.xcodeproj")
+      end
+
+      def target
+        # We don't use the PBXLegacyTarget class (a.k.a External Build System) since it cannot have
+        # build settings and the Xcode's code completion cannot be enabled.
+        @target ||= project.new_target(:static_library, name, :osx).tap do |target|
+          target.product_reference = nil
+          target.build_phases.clear
+          project.targets << target
+        end
+      end
+
+      def configure_header_search_paths
+        target.build_configurations.each do |config|
+          config.build_settings['HEADER_SEARCH_PATHS'] = ruby_header_paths.join(' ')
+        end
+      end
+
+      def configure_build_phase
+        return unless build_command
+
+        build_phase = target.new_shell_script_build_phase
+
+        build_phase.shell_path = '/usr/bin/ruby'
+
+        # Xcode automatically sets a number of environment variables from the Xcode project's build
+        # settings and clang refers them. However we configure the build settings only for code
+        # completion in Xcode and they may be wrong for the real build. So we reset the Xcode's
+        # environments variables and restore the current variables before invoking the external
+        # build command.
+        build_phase.shell_script = <<-END.gsub(/^\s+\|/, '')
+          |ENV.clear
+          |ENV.update(#{ENV.to_hash.inspect})
+          |system(#{build_command.inspect})
+        END
+      end
+
+      def configure_groups
+        project.main_group.clear
+
+        group = project.new_group('Sources')
+
+        file_references = Dir['ext/**/*.{h,c}'].map do |path|
+          group.new_reference(path, :project)
+        end
+
+        # Xcode's code completion is enabled only in files that are compiled in the active target.
+        target.add_file_references(file_references)
+
+        group.sort
+      end
+
+      def ruby_header_paths
+        if rbenv.available?
+          rbenv.ruby_header_paths
+        else
+          xcode.ruby_header_paths
+        end
+      end
+
+      def rbenv
+        @rbenv ||= Rbenv.new
+      end
+
+      def xcode
+        @xcode ||= Xcode.new
+      end
+    end
+  end
+end

data/lib/rubygems/xcodeproj_generator/rake_task.rb

@@ -0,0 +1,28 @@
+require 'rake'
+require 'rake/tasklib'
+require 'rubygems/xcodeproj_generator/project'
+
+module Rubygems
+  module XcodeprojGenerator
+    class RakeTask < ::Rake::TaskLib
+      include ::Rake::DSL if defined?(::Rake::DSL)
+
+      def initialize(name = :generate_xcode_project)
+        unless ::Rake.application.last_comment
+          desc 'Generate an Xcode project for C extension development'
+        end
+
+        task(name) do
+          project = Project.new
+
+          yield project
+
+          project.name ||= File.basename(Dir.pwd)
+          project.save
+
+          puts "Xcode project has been generated to #{project.path}."
+        end
+      end
+    end
+  end
+end

data/lib/rubygems/xcodeproj_generator/rbenv.rb

@@ -0,0 +1,40 @@
+require 'rubygems/xcodeproj_generator/abstract_ruby_header_provider'
+
+module Rubygems
+  module XcodeprojGenerator
+    class Rbenv < AbstractRubyHeaderProvider
+      DEFAULT_ROOT_PATH = '~/.rbenv'
+      VERSIONS_PATH = 'versions'
+
+      def initialize(root_path = nil)
+        root_path ||= ENV['RBENV_ROOT'] || DEFAULT_ROOT_PATH
+        super(root_path)
+      end
+
+      private
+
+      def base_ruby_header_path
+        return nil unless latest_cruby_version
+        find_path(root_path, VERSIONS_PATH, latest_cruby_version, 'include/ruby-*')
+      end
+
+      def latest_cruby_version
+        cruby_versions.sort_by { |version| Gem::Version.new(version) }.last
+      end
+
+      def cruby_versions
+        versions.select { |version| version.match(/\A\d+\.\d+\.\d+/) }
+      end
+
+      def versions
+        return [] unless available?
+
+        versions_dir = File.join(root_path, VERSIONS_PATH)
+
+        Dir.chdir(versions_dir) do
+          Dir['*']
+        end
+      end
+    end
+  end
+end

data/lib/rubygems/xcodeproj_generator/version.rb

@@ -0,0 +1,13 @@
+module Rubygems
+  module XcodeprojGenerator
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+
+      def self.to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
+end

data/lib/rubygems/xcodeproj_generator/xcode.rb

@@ -0,0 +1,42 @@
+require 'rubygems/xcodeproj_generator/abstract_ruby_header_provider'
+
+module Rubygems
+  module XcodeprojGenerator
+    class Xcode < AbstractRubyHeaderProvider
+      DEFAULT_ROOT_PATH = '/Applications/Xcode.app'
+      OSX_SDKS_PATH = 'Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs'
+      RUBY_INCLUDE_PATH_PATTERN =
+        'System/Library/Frameworks/Ruby.framework/Versions/*/usr/include/*'
+
+      def initialize(root_path = nil)
+        root_path ||= DEFAULT_ROOT_PATH
+        super(root_path)
+      end
+
+      private
+
+      def base_ruby_header_path
+        return nil unless latest_osx_sdk
+        find_path(root_path, OSX_SDKS_PATH, latest_osx_sdk, RUBY_INCLUDE_PATH_PATTERN)
+      end
+
+      def latest_osx_sdk
+        osx_sdks.sort_by do |sdk|
+          version = sdk.match(/\d+\.\d+/).to_s
+          Gem::Version.new(version)
+        end.last
+      end
+
+      def osx_sdks
+        return [] unless available?
+
+        sdks_dir = File.join(root_path, OSX_SDKS_PATH)
+        return [] unless Dir.exist?(sdks_dir)
+
+        Dir.chdir(sdks_dir) do
+          Dir['*']
+        end
+      end
+    end
+  end
+end

data/rubygems-xcodeproj_generator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubygems/xcodeproj_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubygems-xcodeproj_generator'
+  spec.version       = Rubygems::XcodeprojGenerator::Version.to_s
+  spec.authors       = ['Yuji Nakayama']
+  spec.email         = ['nkymyj@gmail.com']
+
+  spec.summary       = 'Provides a Rake task for generating an Xcode project ' \
+                       'for C extension development.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/yujinakayama/rubygems-xcodeproj_generator'
+  spec.license       = 'MIT'
+
+  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_runtime_dependency 'xcodeproj', '~> 0.23'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rubygems-xcodeproj_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Nakayama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Provides a Rake task for generating an Xcode project for C extension
+  development.
+email:
+- nkymyj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubygems/xcodeproj_generator.rb
+- lib/rubygems/xcodeproj_generator/abstract_ruby_header_provider.rb
+- lib/rubygems/xcodeproj_generator/project.rb
+- lib/rubygems/xcodeproj_generator/rake_task.rb
+- lib/rubygems/xcodeproj_generator/rbenv.rb
+- lib/rubygems/xcodeproj_generator/version.rb
+- lib/rubygems/xcodeproj_generator/xcode.rb
+- rubygems-xcodeproj_generator.gemspec
+homepage: https://github.com/yujinakayama/rubygems-xcodeproj_generator
+licenses:
+- MIT
+metadata: {}
+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.6
+signing_key: 
+specification_version: 4
+summary: Provides a Rake task for generating an Xcode project for C extension development.
+test_files: []