languages 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d12556cf95cd74fbd61a95960484102707915f7
+  data.tar.gz: 46f2359172a824bffd38971b54ef09c2885d9229
+SHA512:
+  metadata.gz: 90c454846e3e7dc10e37e150448145a0877c455140965600642a01d3c6894595a5c9bf20c9d56fcf6ddfb2690ee629811cc20dc59d3dec39f41eb4fbdbff30b0
+  data.tar.gz: b1c331b1e8cf829cad2d0bb04ec9c7ad9716767207c48a5f135175e04a7be4c2a05b7fe95f9a396da5251989a921201ae07a0e12096bd70dc97b47263dbc2c40

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Andrew Nesbitt
+
+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,35 @@
+# Languages
+
+Just the language names and colors extracted from [github-lingust](https://github.com/github/linguist), avoiding the heavy dependencies like `charlock_holmes` which doesn't install well on heroku.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'languages'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install languages
+
+## Usage
+
+```ruby
+Languages::Language['ruby'] #=> <Languages::Language name=Ruby color=#701516>
+
+Languages::Language.all #=> [#<Languages::Language name=ActionScript color=#e3491a>, ..]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/andrew/languages/fork )
+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 a new Pull Request

data/Rakefile

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

data/languages.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'languages/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "languages"
+  spec.version       = Languages::VERSION
+  spec.authors       = ["Andrew Nesbitt"]
+  spec.email         = ["andrewnez@gmail.com"]
+  spec.summary       = "Github languages and colors"
+  spec.description   = "Just the language names and colors from github-lingust"
+  spec.homepage      = "https://github.com/andrew/languages"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/languages/version.rb

@@ -0,0 +1,3 @@
+module Languages
+  VERSION = "1.0.0"
+end

data/lib/languages.rb

@@ -0,0 +1,409 @@
+require 'escape_utils'
+require 'yaml'
+
+module Languages
+  # Language names that are recognizable by GitHub. Defined languages
+  # can be highlighted, searched and listed under the Top Languages page.
+  #
+  # Languages are defined in `lib/languages.yml`.
+  class Language
+    @languages       = []
+    @index           = {}
+    @name_index      = {}
+    @alias_index     = {}
+
+    # Valid Languages types
+    TYPES = [:data, :markup, :programming, :prose]
+
+    # Detect languages by a specific type
+    #
+    # type - A symbol that exists within TYPES
+    #
+    # Returns an array
+    def self.by_type(type)
+      all.select { |h| h.type == type }
+    end
+
+    # Internal: Create a new Language object
+    #
+    # attributes - A hash of attributes
+    #
+    # Returns a Language object
+    def self.create(attributes = {})
+      language = new(attributes)
+
+      @languages << language
+
+      # All Language names should be unique. Raise if there is a duplicate.
+      if @name_index.key?(language.name)
+        raise ArgumentError, "Duplicate language name: #{language.name}"
+      end
+
+      # Language name index
+      @index[language.name.downcase] = @name_index[language.name.downcase] = language
+
+      language.aliases.each do |name|
+        # All Language aliases should be unique. Raise if there is a duplicate.
+        if @alias_index.key?(name)
+          raise ArgumentError, "Duplicate alias: #{name}"
+        end
+
+        @index[name.downcase] = @alias_index[name.downcase] = language
+      end
+
+      language.extensions.each do |extension|
+        if extension !~ /^\./
+          raise ArgumentError, "Extension is missing a '.': #{extension.inspect}"
+        end
+
+        @extension_index[extension] << language
+      end
+
+      language.interpreters.each do |interpreter|
+        @interpreter_index[interpreter] << language
+      end
+
+      language.filenames.each do |filename|
+        @filename_index[filename] << language
+      end
+
+      language
+    end
+
+    # Public: Get all Languages
+    #
+    # Returns an Array of Languages
+    def self.all
+      @languages
+    end
+
+    # Public: Look up Language by its proper name.
+    #
+    # name - The String name of the Language
+    #
+    # Examples
+    #
+    #   Language.find_by_name('Ruby')
+    #   # => #<Language name="Ruby">
+    #
+    # Returns the Language or nil if none was found.
+    def self.find_by_name(name)
+      name && @name_index[name.downcase]
+    end
+
+    # Public: Look up Language by one of its aliases.
+    #
+    # name - A String alias of the Language
+    #
+    # Examples
+    #
+    #   Language.find_by_alias('cpp')
+    #   # => #<Language name="C++">
+    #
+    # Returns the Language or nil if none was found.
+    def self.find_by_alias(name)
+      name && @alias_index[name.downcase]
+    end
+
+    # Public: Look up Language by its name.
+    #
+    # name - The String name of the Language
+    #
+    # Examples
+    #
+    #   Language['Ruby']
+    #   # => #<Language name="Ruby">
+    #
+    #   Language['ruby']
+    #   # => #<Language name="Ruby">
+    #
+    # Returns the Language or nil if none was found.
+    def self.[](name)
+      name && @index[name.downcase]
+    end
+
+    # Public: A List of popular languages
+    #
+    # Popular languages are sorted to the top of language chooser
+    # dropdowns.
+    #
+    # This list is configured in "popular.yml".
+    #
+    # Returns an Array of Languages.
+    def self.popular
+      @popular ||= all.select(&:popular?).sort_by { |lang| lang.name.downcase }
+    end
+
+    # Public: A List of non-popular languages
+    #
+    # Unpopular languages appear below popular ones in language
+    # chooser dropdowns.
+    #
+    # This list is created from all the languages not listed in "popular.yml".
+    #
+    # Returns an Array of Languages.
+    def self.unpopular
+      @unpopular ||= all.select(&:unpopular?).sort_by { |lang| lang.name.downcase }
+    end
+
+    # Public: A List of languages with assigned colors.
+    #
+    # Returns an Array of Languages.
+    def self.colors
+      @colors ||= all.select(&:color).sort_by { |lang| lang.name.downcase }
+    end
+
+    # Internal: Initialize a new Language
+    #
+    # attributes - A hash of attributes
+    def initialize(attributes = {})
+      # @name is required
+      @name = attributes[:name] || raise(ArgumentError, "missing name")
+
+      # Set type
+      @type = attributes[:type] ? attributes[:type].to_sym : nil
+      if @type && !TYPES.include?(@type)
+        raise ArgumentError, "invalid type: #{@type}"
+      end
+
+      @color = attributes[:color]
+
+      # Set aliases
+      @aliases = [default_alias_name] + (attributes[:aliases] || [])
+
+      # Load the TextMate scope name or try to guess one
+      @tm_scope = attributes[:tm_scope] || begin
+        context = case @type
+                  when :data, :markup, :prose
+                    'text'
+                  when :programming, nil
+                    'source'
+                  end
+        "#{context}.#{@name.downcase}"
+      end
+
+      @ace_mode = attributes[:ace_mode]
+      @wrap = attributes[:wrap] || false
+
+      # Set legacy search term
+      @search_term = attributes[:search_term] || default_alias_name
+
+      # Set extensions or default to [].
+      @extensions = attributes[:extensions] || []
+      @interpreters = attributes[:interpreters]   || []
+      @filenames  = attributes[:filenames]  || []
+
+      # Set popular, and searchable flags
+      @popular    = attributes.key?(:popular)    ? attributes[:popular]    : false
+      @searchable = attributes.key?(:searchable) ? attributes[:searchable] : true
+
+      # If group name is set, save the name so we can lazy load it later
+      if attributes[:group_name]
+        @group = nil
+        @group_name = attributes[:group_name]
+
+      # Otherwise we can set it to self now
+      else
+        @group = self
+      end
+    end
+
+    # Public: Get proper name
+    #
+    # Examples
+    #
+    #   # => "Ruby"
+    #   # => "Python"
+    #   # => "Perl"
+    #
+    # Returns the name String
+    attr_reader :name
+
+    # Public: Get type.
+    #
+    # Returns a type Symbol or nil.
+    attr_reader :type
+
+    # Public: Get color.
+    #
+    # Returns a hex color String.
+    attr_reader :color
+
+    # Public: Get aliases
+    #
+    # Examples
+    #
+    #   Language['C++'].aliases
+    #   # => ["cpp"]
+    #
+    # Returns an Array of String names
+    attr_reader :aliases
+
+    # Deprecated: Get code search term
+    #
+    # Examples
+    #
+    #   # => "ruby"
+    #   # => "python"
+    #   # => "perl"
+    #
+    # Returns the name String
+    attr_reader :search_term
+
+    # Public: Get the name of a TextMate-compatible scope
+    #
+    # Returns the scope
+    attr_reader :tm_scope
+
+    # Public: Get Ace mode
+    #
+    # Examples
+    #
+    #  # => "text"
+    #  # => "javascript"
+    #  # => "c_cpp"
+    #
+    # Returns a String name or nil
+    attr_reader :ace_mode
+
+    # Public: Should language lines be wrapped
+    #
+    # Returns true or false
+    attr_reader :wrap
+
+    # Public: Get extensions
+    #
+    # Examples
+    #
+    #   # => ['.rb', '.rake', ...]
+    #
+    # Returns the extensions Array
+    attr_reader :extensions
+
+    # Public: Get interpreters
+    #
+    # Examples
+    #
+    #   # => ['awk', 'gawk', 'mawk' ...]
+    #
+    # Returns the interpreters Array
+    attr_reader :interpreters
+
+    # Public: Get filenames
+    #
+    # Examples
+    #
+    #   # => ['Rakefile', ...]
+    #
+    # Returns the extensions Array
+    attr_reader :filenames
+
+    # Deprecated: Get primary extension
+    #
+    # Defaults to the first extension but can be overridden
+    # in the languages.yml.
+    #
+    # The primary extension can not be nil. Tests should verify this.
+    #
+    # This method is only used by app/helpers/gists_helper.rb for creating
+    # the language dropdown. It really should be using `name` instead.
+    # Would like to drop primary extension.
+    #
+    # Returns the extension String.
+    def primary_extension
+      extensions.first
+    end
+
+    # Public: Get URL escaped name.
+    #
+    # Examples
+    #
+    #   "C%23"
+    #   "C%2B%2B"
+    #   "Common%20Lisp"
+    #
+    # Returns the escaped String.
+    def escaped_name
+      EscapeUtils.escape_url(name).gsub('+', '%20')
+    end
+
+    # Internal: Get default alias name
+    #
+    # Returns the alias name String
+    def default_alias_name
+      name.downcase.gsub(/\s/, '-')
+    end
+
+    # Public: Get Language group
+    #
+    # Returns a Language
+    def group
+      @group ||= Language.find_by_name(@group_name)
+    end
+
+    # Public: Is it popular?
+    #
+    # Returns true or false
+    def popular?
+      @popular
+    end
+
+    # Public: Is it not popular?
+    #
+    # Returns true or false
+    def unpopular?
+      !popular?
+    end
+
+    # Public: Is it searchable?
+    #
+    # Unsearchable languages won't by indexed by solr and won't show
+    # up in the code search dropdown.
+    #
+    # Returns true or false
+    def searchable?
+      @searchable
+    end
+
+    # Public: Return name as String representation
+    def to_s
+      name
+    end
+
+    def ==(other)
+      eql?(other)
+    end
+
+    def eql?(other)
+      equal?(other)
+    end
+
+    def hash
+      name.hash
+    end
+
+    def inspect
+      "#<#{self.class} name=#{name} color=#{color}>"
+    end
+  end
+
+  popular = YAML.load_file(File.expand_path("../popular.yml", __FILE__))
+
+  languages = YAML.load_file(File.expand_path("../languages.yml", __FILE__))
+
+  languages.each do |name, options|
+    Language.create(
+      :name              => name,
+      :color             => options['color'],
+      :type              => options['type'],
+      :aliases           => options['aliases'],
+      :tm_scope          => options['tm_scope'],
+      :ace_mode          => options['ace_mode'],
+      :wrap              => options['wrap'],
+      :group_name        => options['group'],
+      :searchable        => options.fetch('searchable', true),
+      :search_term       => options['search_term'],
+      :popular           => popular.include?(name)
+    )
+  end
+end