Contents

module Inch
  # The API module is the entry point for Inch's APIs
  #
  # APIs are kind of "use cases" that are utilized by the CLI classes to
  # actually "do things".
  #
  # Example:
  #
  #   $ inch list lib/**/*.rb --private
  #
  # This basically calls something like this:
  #
  #   codebase = Codebase::Proxy.new(Dir.pwd, ["lib/**/*.rb"], [])
  #   options = {:visibility => [:public, :protected, :private]}
  #   context = API::List.new(codebase, options)
  #   context.objects # => Array
  #
  # The List API takes a Codebase::Proxy object and an options
  # hash or a class in API::Options and returns objects and grade_lists
  # matching that options.
  #
  module API
  end
end

require_relative 'api/options/base'
require_relative 'api/options/filter'
require_relative 'api/options/suggest'

require_relative 'api/filter'
require_relative 'api/get'
require_relative 'api/list'
require_relative 'api/suggest'
require_relative 'api/stats'

Version data entries

17 entries across 17 versions & 1 rubygems

Version	Path
inch-0.3.4.rc1	lib/inch/api.rb
inch-0.3.3	lib/inch/api.rb
inch-0.3.3.rc1	lib/inch/api.rb
inch-0.3.2	lib/inch/api.rb
inch-0.3.2.rc2	lib/inch/api.rb
inch-0.3.2.rc1	lib/inch/api.rb
inch-0.3.1	lib/inch/api.rb
inch-0.3.1.rc6	lib/inch/api.rb
inch-0.3.1.rc5	lib/inch/api.rb
inch-0.3.1.rc4	lib/inch/api.rb
inch-0.3.1.rc3	lib/inch/api.rb
inch-0.3.1.rc2	lib/inch/api.rb
inch-0.3.1.rc1	lib/inch/api.rb
inch-0.3.0	lib/inch/api.rb
inch-0.3.0.rc3	lib/inch/api.rb
inch-0.3.0.rc2	lib/inch/api.rb
inch-0.3.0.rc1	lib/inch/api.rb