linguists_field_guide 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae061f63a71b6d42eb73abb18fdae1f52a5eecab99bc7ca1883555bebf69b984
-  data.tar.gz: 02bb01e96a9fc5be28d974d960e30a3facd69ff689b93f9ac78011030459881a
+  metadata.gz: 532c20c1f701a06f5b7a65ad45fd1f4b3f8a0f1a3c2b4a2dbd585fba718c03fa
+  data.tar.gz: 95d2a8b50e1ace52ba9f176c1095e3a824465463766108d992d1be5422985136
 SHA512:
-  metadata.gz: 3ebc711be01aa1331122c2c76ee1efada429f1130f46f64ca613ccc48eaf64cdc836377f530d14bc39451152a3b23fa06b0a5478b1c2a41cf3777ee3fcccdb27
-  data.tar.gz: 10d79ad8c3d828c3e461b5a318e03469c56e21f624956d109b00b2332d3d6abd4d4efa60d05e6257bcd3d6bb4e4d1e83a251f1673329d73964198d89f13e1373
+  metadata.gz: de2c42438ca6a7909629eca34a124acd63187e758f494b25164c722bf2a2929becab6df31186a26f909aa7049e8ba0856e443bdb9079645be20b1239d575c0db
+  data.tar.gz: 2ff13038a2b91d1d682be3f89872c95a0b34aa3b5e4bc99b08b82414967bf16bc8e2bd04756156010a1682ed41f11b8ba3813d04c03668cf4dcf1956f7dc650b

data/LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-**Copyright © 2020 Jessica Stokes**
+**Copyright © 2021 Jessica Stokes**
 
 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:
 

data/README.md

@@ -1,6 +1,6 @@
 # Linguist's Field Guide 📖
 
-[![Gem Version](https://badge.fury.io/rb/linguists_field_guide.svg)](https://rubygems.org/gems/linguists_field_guide) [![Ruby](https://github.com/ticky/linguists-field-guide/workflows/Ruby/badge.svg)](https://github.com/ticky/linguists-field-guide/actions?query=workflow%3ARuby)
+[![Gem Version](https://badge.fury.io/rb/linguists_field_guide.svg)](https://rubygems.org/gems/linguists_field_guide) [![Ruby](https://github.com/ticky/linguists-field-guide/workflows/Ruby/badge.svg)](https://github.com/ticky/linguists-field-guide/actions?query=workflow%3ARuby) [![codecov](https://codecov.io/gh/ticky/linguists-field-guide/branch/develop/graph/badge.svg?token=LMD2XU2S6N)](https://codecov.io/gh/ticky/linguists-field-guide)
 
 Field guide for programming languages, based on the knowledge imparted by `github-linguist`.
 
@@ -25,10 +25,9 @@ gem install linguists_field_guide
 `LinguistsFieldGuide::Language` provides a subset of `Linguist::Language`;
 
 - An Array of all Languages can be retrieved by calling `LinguistsFieldGuide::Language.all`
+- A specific Language can be found by using `LinguistsFieldGuide::Language.find_by_name`
 - Other `Linguist::Language` class methods (`find_by_alias`, `find_by_extension`, `find_by_filename`, etc.) are not currently provided.
 - `Language` instances contain readers for properties included in the version of `Linguist` it was built against, with these exceptions:
-  - `Language` instances do not have a `group` property.  
-    If a given `Language` is a group, the `group_name` property will contain the `name` of the Language it is a child of.
   - Derived methods (`default_alias`, `escaped_name`, `hash`, etc.) are not currently provided.
 
 ### Example
@@ -39,7 +38,7 @@ require 'linguists_field_guide'
 languages_to_check = ["Rust", "Ruby", "JavaScript", "Bash"]
 
 languages_to_check.each do |language_name|
-  if LinguistsFieldGuide::Language.all.any? { |lang| lang.name === language_name }
+  if LinguistsFieldGuide::Language.find_by_name(language_name)
     puts "⭕️ #{language_name} is a known language name"
   else
     puts "❌ #{language_name} isn't a known language name!"

data/lib/linguists_field_guide.rb

@@ -1,3 +1,6 @@
+# This file is generated by the build system.
+# Please make any edits in lib/linguists_field_guide.rb instead.
+
 require 'json'
 
 module LinguistsFieldGuide
@@ -9,13 +12,13 @@ module LinguistsFieldGuide
   # class, with just enough information to use for reference.
   class Language
     @languages = []
+    @index = {}
+    @name_index = {}
 
     #See [github-linguist's documentation of `name`](https://www.rubydoc.info/gems/github-linguist/Linguist/Language#name-instance_method)
     attr_reader :name
     #See [github-linguist's documentation of `fs_name`](https://www.rubydoc.info/gems/github-linguist/Linguist/Language#fs_name-instance_method)
     attr_reader :fs_name
-    #See [github-linguist's documentation of `type`](https://www.rubydoc.info/gems/github-linguist/Linguist/Language#type-instance_method)
-    attr_reader :type
     #See [github-linguist's documentation of `color`](https://www.rubydoc.info/gems/github-linguist/Linguist/Language#color-instance_method)
     attr_reader :color
     #See [github-linguist's documentation of `aliases`](https://www.rubydoc.info/gems/github-linguist/Linguist/Language#aliases-instance_method)
@@ -38,30 +41,58 @@ module LinguistsFieldGuide
     attr_reader :interpreters
     #See [github-linguist's documentation of `filenames`](https://www.rubydoc.info/gems/github-linguist/Linguist/Language#filenames-instance_method)
     attr_reader :filenames
-    #The name of the language this language should be grouped under
-    attr_reader :group_name
 
     # Internal: Creates a Language object,
     # applies all the given attributes to instance variables,
     # and adds it to the `#all` list.
+    # @private
     def self.create(attributes)
       language = new(attributes)
 
       @languages << language
+
+      @index[language.name.downcase] = @name_index[language.name.downcase] = language
     end
 
     # Internal: Applies all the given attributes to instance variables.
+    # @private
     def initialize(attributes)
       attributes.each do |key, value|
         instance_variable_set(key, value)
       end
     end
 
-    # Returns an Array of Languages
+    # @return [Array<Language>]
     def self.all
       @languages
     end
 
+    # Look up Language by its proper name.
+    #
+    # @param [String] name The proper name of a Language
+    def self.find_by_name(name)
+      @name_index[name&.downcase]
+    end
+
+    # Get Language group
+    #
+    # @return [Language] The Language group
+    def group
+      @group ||= if @group_name.nil?
+                   self
+                 else
+                   Language.find_by_name(@group_name)
+                 end
+    end
+
+    # Get type.
+    #
+    # @return [Symbol] One of the defined
+    #   [`Linguist::Language::TYPES`](https://www.rubydoc.info/gems/github-linguist/Linguist/Language#TYPES-constant)
+    def type
+      @type.to_sym
+    end
+
     # Is it popular?
     def popular?
       @popular
@@ -1363,6 +1394,31 @@ module LinguistsFieldGuide
         "@popular": false,
         "@searchable": true
       },
+      {
+        "@name": "Browserslist",
+        "@fs_name": null,
+        "@type": "data",
+        "@color": "#ffd539",
+        "@aliases": [
+          "browserslist"
+        ],
+        "@tm_scope": "text.browserslist",
+        "@ace_mode": "text",
+        "@codemirror_mode": null,
+        "@codemirror_mime_type": null,
+        "@wrap": false,
+        "@language_id": 153503348,
+        "@extensions": [
+        ],
+        "@interpreters": [
+        ],
+        "@filenames": [
+          ".browserslistrc",
+          "browserslist"
+        ],
+        "@popular": false,
+        "@searchable": true
+      },
       {
         "@name": "C",
         "@fs_name": null,
@@ -4983,7 +5039,8 @@ module LinguistsFieldGuide
         "@color": null,
         "@aliases": [
           "html+eex",
-          "eex"
+          "eex",
+          "leex"
         ],
         "@tm_scope": "text.html.elixir",
         "@ace_mode": "text",
@@ -4992,7 +5049,8 @@ module LinguistsFieldGuide
         "@wrap": false,
         "@language_id": 149,
         "@extensions": [
-          ".eex"
+          ".eex",
+          ".html.leex"
         ],
         "@interpreters": [
         ],
@@ -5853,6 +5911,7 @@ module LinguistsFieldGuide
           ".jscsrc",
           ".jshintrc",
           ".jslintrc",
+          "devcontainer.json",
           "jsconfig.json",
           "language-configuration.json",
           "tsconfig.json",
@@ -6604,7 +6663,8 @@ module LinguistsFieldGuide
         "@wrap": false,
         "@language_id": 194,
         "@extensions": [
-          ".lvproj"
+          ".lvproj",
+          ".lvlib"
         ],
         "@interpreters": [
         ],
@@ -6613,6 +6673,31 @@ module LinguistsFieldGuide
         "@popular": false,
         "@searchable": true
       },
+      {
+        "@name": "Lark",
+        "@fs_name": null,
+        "@type": "data",
+        "@color": "#0b130f",
+        "@aliases": [
+          "lark"
+        ],
+        "@tm_scope": "source.lark",
+        "@ace_mode": "text",
+        "@codemirror_mode": "ebnf",
+        "@codemirror_mime_type": "text/x-ebnf",
+        "@wrap": false,
+        "@language_id": 758480799,
+        "@extensions": [
+          ".lark"
+        ],
+        "@interpreters": [
+        ],
+        "@filenames": [
+        ],
+        "@popular": false,
+        "@searchable": true,
+        "@group_name": "EBNF"
+      },
       {
         "@name": "Lasso",
         "@fs_name": null,
@@ -8232,6 +8317,30 @@ module LinguistsFieldGuide
         "@popular": false,
         "@searchable": true
       },
+      {
+        "@name": "NWScript",
+        "@fs_name": null,
+        "@type": "programming",
+        "@color": "#111522",
+        "@aliases": [
+          "nwscript"
+        ],
+        "@tm_scope": "source.c.nwscript",
+        "@ace_mode": "c_cpp",
+        "@codemirror_mode": "clike",
+        "@codemirror_mime_type": "text/x-csrc",
+        "@wrap": false,
+        "@language_id": 731233819,
+        "@extensions": [
+          ".nss"
+        ],
+        "@interpreters": [
+        ],
+        "@filenames": [
+        ],
+        "@popular": false,
+        "@searchable": true
+      },
       {
         "@name": "Nearley",
         "@fs_name": null,
@@ -9046,7 +9155,8 @@ module LinguistsFieldGuide
         "@wrap": false,
         "@language_id": 598917541,
         "@extensions": [
-          ".plist"
+          ".plist",
+          ".glyphs"
         ],
         "@interpreters": [
         ],
@@ -9764,7 +9874,7 @@ module LinguistsFieldGuide
         "@aliases": [
           "pod-6"
         ],
-        "@tm_scope": "source.perl6fe",
+        "@tm_scope": "source.raku",
         "@ace_mode": "perl",
         "@codemirror_mode": null,
         "@codemirror_mime_type": null,
@@ -10771,7 +10881,7 @@ module LinguistsFieldGuide
           "perl6",
           "perl-6"
         ],
-        "@tm_scope": "source.perl6fe",
+        "@tm_scope": "source.raku",
         "@ace_mode": "perl",
         "@codemirror_mode": "perl",
         "@codemirror_mime_type": "text/x-perl",
@@ -10849,6 +10959,31 @@ module LinguistsFieldGuide
         "@popular": false,
         "@searchable": true
       },
+      {
+        "@name": "ReScript",
+        "@fs_name": null,
+        "@type": "programming",
+        "@color": "#ed5051",
+        "@aliases": [
+          "rescript"
+        ],
+        "@tm_scope": "source.rescript",
+        "@ace_mode": "rust",
+        "@codemirror_mode": "rust",
+        "@codemirror_mime_type": "text/x-rustsrc",
+        "@wrap": false,
+        "@language_id": 501875647,
+        "@extensions": [
+          ".res"
+        ],
+        "@interpreters": [
+          "ocaml"
+        ],
+        "@filenames": [
+        ],
+        "@popular": false,
+        "@searchable": true
+      },
       {
         "@name": "Readline Config",
         "@fs_name": null,
@@ -13036,6 +13171,7 @@ module LinguistsFieldGuide
           "README.1ST",
           "README.me",
           "README.mysql",
+          "README.nss",
           "click.me",
           "delete.me",
           "go.mod",
@@ -14209,6 +14345,7 @@ module LinguistsFieldGuide
           ".psc1",
           ".pt",
           ".rdf",
+          ".res",
           ".resx",
           ".rss",
           ".sch",

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: linguists_field_guide
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jessica Stokes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.21.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.21.1
 - !ruby/object:Gem::Dependency
   name: github-linguist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.11.1
+        version: 7.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.11.1
+        version: 7.12.2
 description: Field guide for programming languages, based on the knowledge imparted
   by github-linguist
 email: hello@jessicastokes.net
@@ -80,7 +80,7 @@ homepage: https://github.com/ticky/linguists-field-guide
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.4
+signing_key:
 specification_version: 4
 summary: Linguist's Field Guide
 test_files: []