sexp_info 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bd8f82aa90eba808eabde7302f2030462df7757
+  data.tar.gz: d3311b73d1c0bc5892cc670cfcd70223bf075ddd
+SHA512:
+  metadata.gz: 686b50130c78bb0d5a246283a1297bf8317e40eba43b6eb06782e0f36f8bd74770972730b140fc5a0502fc21823d181e4b78e4bdbd645518f3df061106fad90a
+  data.tar.gz: 23b78fc01e4303c28f08f29c83f0d82215b9a02ceeec93d27541deebb9c873ec00ae05155e58235fe080f7f988f03b66ddc7681e631777e05e45df3f7c102df1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~

data/.rspec

@@ -0,0 +1 @@
+--color --format nested

data/.rvmrc

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 2.0.0" > .rvmrc
+environment_id="ruby-2.0.0-p195@sexp_info"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.20.12 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 1 )) # display automatically
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: \E[32m$GEM_HOME\E[0m" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 svs
+
+MIT License
+
+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,47 @@
+# SexpInfo
+
+This gem provides nice information about your program based on Ripper sexps. Given a ruby source file called foo.rb
+
+```ruby
+class Foo
+  def bar(baz, quux = 123)
+    "yikes"
+  end
+end
+```
+
+we can do the folliwng
+
+```ruby
+  rip = Ripper.sexp(File.read('foo.rb'))
+  si = SexpInfo.new(rip)
+  si.defined_methods # => ["bar"]
+  si["bar"].arity # => 2
+  si["bar"].args[1].optional? # => true
+```
+
+Please check the specs for more information
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sexp_info'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sexp_info
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sexp_info.rb

@@ -0,0 +1,37 @@
+require "sexp_info/version"
+require 'active_support/all'
+require 'sexp_info/sexp_thing/sexp_thing'
+class SexpInfo
+
+  def initialize(sexp)
+    @sexp = sexp
+  end
+
+  def type
+    sexp[1][0][0]
+  end
+
+  def defined_methods
+    defined(:def)
+  end
+
+  def defined_classes
+    defined(:class)
+  end
+
+  def defined_modules
+    defined(:module)
+  end
+
+  def [](name)
+    (defined_classes + defined_methods + defined_modules).find{|m| m == name }
+  end
+
+  private
+
+  attr_reader :sexp
+  def defined(type)
+    sexp[1] ? sexp[1].find_all{|s| s[0] == type}.map{|c| "SexpThing::#{type.to_s.camelize}".constantize.new(c) } : []
+  end
+
+end

data/lib/sexp_info/sexp_thing/arg.rb

@@ -0,0 +1,15 @@
+module SexpThing
+
+  class Arg < Base
+
+    def name
+      sexp[1]
+    end
+
+    def optional?
+      sexp.count == 2
+    end
+
+  end
+
+end

data/lib/sexp_info/sexp_thing/args.rb

@@ -0,0 +1,31 @@
+module SexpThing
+
+  class Args < Base
+
+    def [](index)
+      args[index]
+    end
+
+    def count
+      args.count
+    end
+
+    private
+
+    def args
+      arg_list + optional_args_list
+    end
+
+    def arg_list
+      return (sexp[1] ? [Arg.new(sexp[1])] : []) if sexp[0] == :params
+      (sexp[0] == :paren ? sexp[1][1] : sexp[1]).map{|a| Arg.new(a) }
+    end
+
+    def optional_args_list
+      as = (sexp[0] == :paren ? sexp[1][2] : sexp[2])
+      as ? as.map{|a| Arg.new(a) } : []
+    end
+
+  end
+
+end

data/lib/sexp_info/sexp_thing/class.rb

@@ -0,0 +1,14 @@
+module SexpThing
+
+  class Class < Base
+
+    def name
+      sexp[1][1][1]
+    end
+
+    def defined_methods
+      SexpInfo.new(sexp[3]).defined_methods
+    end
+  end
+
+end

data/lib/sexp_info/sexp_thing/def.rb

@@ -0,0 +1,17 @@
+module SexpThing
+  class Def < Base
+
+    def name
+      sexp[1][1]
+    end
+
+    def arity
+      args.count
+    end
+
+    def args
+      Args.new(sexp[2])
+    end
+
+  end
+end

data/lib/sexp_info/sexp_thing/module.rb

@@ -0,0 +1,12 @@
+module SexpThing
+
+  class Module < Base
+    def name
+      sexp[1][1][1]
+    end
+    def defined_classes
+      SexpInfo.new(sexp[2]).defined_classes
+    end
+  end
+
+end

data/lib/sexp_info/sexp_thing/sexp_thing.rb

@@ -0,0 +1,20 @@
+module SexpThing
+
+  class Base
+    def initialize(sexp)
+      @sexp = sexp
+    end
+
+    def ==(other)
+      other.is_a?(String) ? name == other : self.sexp == other.sexp
+    end
+
+    attr_reader :sexp
+
+  end
+
+end
+
+['args','arg','class','module','def'].each do |m|
+  require_relative m
+end

data/lib/sexp_info/version.rb

@@ -0,0 +1,3 @@
+class SexpInfo
+  VERSION = "0.0.1"
+end

data/sexp_info.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sexp_info/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sexp_info"
+  spec.version       = SexpInfo::VERSION
+  spec.authors       = ["svs"]
+  spec.email         = ["svs@svs.io"]
+  spec.description   = %q{Peek under the hood of sexps}
+  spec.summary       = %q{gracefully}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_dependency "active_support"
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-given"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "pry_debug"
+end

data/spec/fixtures/classes.rb

@@ -0,0 +1,15 @@
+class StdClass
+
+
+  def optional_args(foo, bar = 123)
+    bar - 12
+  end
+
+end
+
+class OtherClass
+
+  def foo
+  end
+
+end

data/spec/fixtures/methods.rb

@@ -0,0 +1,20 @@
+def no_args
+  "no args"
+end
+
+
+def one_arg_no_parens foo
+  foo
+end
+
+def one_arg_parens(foo)
+  foo
+end
+
+def two_args(foo, bar)
+  foo || bar
+end
+
+def optional_args(foo, bar = 123)
+  bar - 12
+end

data/spec/fixtures/modules.rb

@@ -0,0 +1,11 @@
+module StdModule
+
+  class StdClass
+
+    def optional_args(foo, bar = 123)
+      bar - 12
+    end
+
+  end
+
+end

data/spec/lib/sexp_info_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'awesome_print'
+describe SexpInfo do
+
+  context "methods only" do
+    Given(:methods) { File.read('spec/fixtures/methods.rb') }
+    Given(:rip) { Ripper.sexp(methods) }
+    Given(:sexp) { SexpInfo.new(rip) }
+    Then { sexp.type.should == :def }
+    Then { sexp.defined_methods.should == ["no_args", "one_arg_no_parens", "one_arg_parens" ,"two_args", "optional_args"] }
+    Then { sexp["no_args"].arity.should == 0 }
+    Then { sexp["one_arg_no_parens"].arity.should == 1 }
+    Then { sexp["one_arg_parens"].arity.should == 1 }
+    Then { sexp["two_args"].arity.should == 2 }
+    Then { sexp["two_args"].args[0].should_not be_optional }
+    Then { sexp["optional_args"].args[1].should be_optional }
+  end
+
+
+  context "classes" do
+    Given(:classes) { File.read('spec/fixtures/classes.rb') }
+    Given(:rip) { Ripper.sexp(classes) }
+    Given(:sexp) { SexpInfo.new(rip) }
+    Then { sexp.defined_classes.should == ["StdClass", "OtherClass"] }
+    Then { sexp["StdClass"].defined_methods.should == ["optional_args"] }
+  end
+
+  context "classes" do
+    Given(:modules) { File.read('spec/fixtures/modules.rb') }
+    Given(:rip) { Ripper.sexp(modules) }
+    Given(:sexp) { SexpInfo.new(rip) }
+    Then { sexp.type.should == :module }
+    Then { sexp.defined_modules.should == ["StdModule"] }
+    Then { sexp["StdModule"].should be_a SexpThing::Module }
+    Then { sexp["StdModule"].defined_classes.should == ["StdClass"] }
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'rspec-given'
+
+require 'sexp_info'

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: sexp_info
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- svs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec-given
+  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: awesome_print
+  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_debug
+  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: Peek under the hood of sexps
+email:
+- svs@svs.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sexp_info.rb
+- lib/sexp_info/sexp_thing/arg.rb
+- lib/sexp_info/sexp_thing/args.rb
+- lib/sexp_info/sexp_thing/class.rb
+- lib/sexp_info/sexp_thing/def.rb
+- lib/sexp_info/sexp_thing/module.rb
+- lib/sexp_info/sexp_thing/sexp_thing.rb
+- lib/sexp_info/version.rb
+- sexp_info.gemspec
+- spec/fixtures/classes.rb
+- spec/fixtures/methods.rb
+- spec/fixtures/methods.rb~
+- spec/fixtures/modules.rb
+- spec/lib/sexp_info_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.1.5
+signing_key: 
+specification_version: 4
+summary: gracefully
+test_files:
+- spec/fixtures/classes.rb
+- spec/fixtures/methods.rb
+- spec/fixtures/methods.rb~
+- spec/fixtures/modules.rb
+- spec/lib/sexp_info_spec.rb
+- spec/spec_helper.rb