openhab-scripting 4.47.0 → 5.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/openhab/core/actions/audio.rb +54 -0
- data/lib/openhab/core/actions/ephemeris.rb +39 -0
- data/lib/openhab/core/actions/exec.rb +51 -0
- data/lib/openhab/core/actions/http.rb +80 -0
- data/lib/openhab/core/actions/ping.rb +30 -0
- data/lib/openhab/core/actions/transformation.rb +32 -0
- data/lib/openhab/core/actions/voice.rb +36 -0
- data/lib/openhab/core/actions.rb +82 -0
- data/lib/openhab/core/dependency_tracking.rb +34 -0
- data/lib/openhab/core/dto/item_channel_link.rb +33 -0
- data/lib/openhab/core/dto/thing.rb +27 -0
- data/lib/openhab/core/dto.rb +11 -0
- data/lib/openhab/core/entity_lookup.rb +152 -70
- data/lib/openhab/core/events/abstract_event.rb +18 -0
- data/lib/openhab/core/events/abstract_item_registry_event.rb +36 -0
- data/lib/openhab/core/events/abstract_thing_registry_event.rb +40 -0
- data/lib/openhab/core/events/item_command_event.rb +78 -0
- data/lib/openhab/core/events/item_event.rb +22 -0
- data/lib/openhab/core/events/item_state_changed_event.rb +75 -0
- data/lib/openhab/core/events/item_state_event.rb +79 -0
- data/lib/openhab/core/events/item_state_updated_event.rb +22 -0
- data/lib/openhab/core/events/thing_status_info_event.rb +55 -0
- data/lib/openhab/core/events.rb +10 -0
- data/lib/openhab/core/items/accepted_data_types.rb +29 -0
- data/lib/openhab/core/items/color_item.rb +52 -0
- data/lib/openhab/core/items/contact_item.rb +52 -0
- data/lib/openhab/core/items/date_time_item.rb +59 -0
- data/lib/openhab/core/items/dimmer_item.rb +148 -0
- data/lib/openhab/core/items/generic_item.rb +292 -0
- data/lib/openhab/core/items/group_item.rb +176 -0
- data/lib/openhab/{dsl → core}/items/image_item.rb +35 -29
- data/lib/openhab/core/items/item.rb +273 -0
- data/lib/openhab/core/items/location_item.rb +34 -0
- data/lib/openhab/core/items/metadata/hash.rb +433 -0
- data/lib/openhab/core/items/metadata/namespace_hash.rb +475 -0
- data/lib/openhab/core/items/metadata/provider.rb +48 -0
- data/lib/openhab/core/items/metadata.rb +11 -0
- data/lib/openhab/core/items/number_item.rb +62 -0
- data/lib/openhab/core/items/numeric_item.rb +22 -0
- data/lib/openhab/core/items/persistence.rb +416 -0
- data/lib/openhab/core/items/player_item.rb +66 -0
- data/lib/openhab/core/items/provider.rb +44 -0
- data/lib/openhab/core/items/proxy.rb +136 -0
- data/lib/openhab/core/items/registry.rb +86 -0
- data/lib/openhab/core/items/rollershutter_item.rb +68 -0
- data/lib/openhab/core/items/semantics/enumerable.rb +177 -0
- data/lib/openhab/core/items/semantics.rb +473 -0
- data/lib/openhab/core/items/state_storage.rb +53 -0
- data/lib/openhab/core/items/string_item.rb +28 -0
- data/lib/openhab/core/items/switch_item.rb +78 -0
- data/lib/openhab/core/items.rb +108 -0
- data/lib/openhab/{dsl → core}/lazy_array.rb +9 -3
- data/lib/openhab/core/profile_factory.rb +132 -0
- data/lib/openhab/core/provider.rb +230 -0
- data/lib/openhab/core/proxy.rb +130 -0
- data/lib/openhab/core/registry.rb +40 -0
- data/lib/openhab/core/rules/module.rb +26 -0
- data/lib/openhab/core/rules/provider.rb +25 -0
- data/lib/openhab/core/rules/registry.rb +94 -0
- data/lib/openhab/core/rules/rule.rb +174 -0
- data/lib/openhab/core/rules.rb +25 -0
- data/lib/openhab/core/script_handling.rb +78 -20
- data/lib/openhab/core/things/channel.rb +48 -0
- data/lib/openhab/core/things/channel_uid.rb +51 -0
- data/lib/openhab/core/things/item_channel_link.rb +33 -0
- data/lib/openhab/core/things/links/provider.rb +78 -0
- data/lib/openhab/core/things/profile_callback.rb +52 -0
- data/lib/openhab/core/things/provider.rb +29 -0
- data/lib/openhab/core/things/proxy.rb +87 -0
- data/lib/openhab/core/things/registry.rb +73 -0
- data/lib/openhab/core/things/thing.rb +194 -0
- data/lib/openhab/core/things.rb +22 -0
- data/lib/openhab/core/timer.rb +148 -0
- data/lib/openhab/{dsl → core}/types/comparable_type.rb +5 -3
- data/lib/openhab/{dsl → core}/types/date_time_type.rb +55 -127
- data/lib/openhab/{dsl → core}/types/decimal_type.rb +50 -48
- data/lib/openhab/{dsl → core}/types/hsb_type.rb +35 -83
- data/lib/openhab/core/types/increase_decrease_type.rb +34 -0
- data/lib/openhab/core/types/next_previous_type.rb +34 -0
- data/lib/openhab/{dsl → core}/types/numeric_type.rb +20 -7
- data/lib/openhab/core/types/on_off_type.rb +46 -0
- data/lib/openhab/core/types/open_closed_type.rb +41 -0
- data/lib/openhab/{dsl → core}/types/percent_type.rb +19 -20
- data/lib/openhab/core/types/play_pause_type.rb +38 -0
- data/lib/openhab/core/types/point_type.rb +117 -0
- data/lib/openhab/core/types/quantity_type.rb +325 -0
- data/lib/openhab/core/types/raw_type.rb +26 -0
- data/lib/openhab/core/types/refresh_type.rb +27 -0
- data/lib/openhab/core/types/rewind_fastforward_type.rb +38 -0
- data/lib/openhab/core/types/stop_move_type.rb +34 -0
- data/lib/openhab/{dsl → core}/types/string_type.rb +17 -28
- data/lib/openhab/{dsl → core}/types/type.rb +42 -40
- data/lib/openhab/core/types/un_def_type.rb +38 -0
- data/lib/openhab/core/types/up_down_type.rb +50 -0
- data/lib/openhab/core/types.rb +82 -0
- data/lib/openhab/{dsl → core}/uid.rb +4 -23
- data/lib/openhab/core/value_cache.rb +188 -0
- data/lib/openhab/core.rb +98 -0
- data/lib/openhab/core_ext/between.rb +32 -0
- data/lib/openhab/core_ext/ephemeris.rb +53 -0
- data/lib/openhab/core_ext/java/class.rb +34 -0
- data/lib/openhab/core_ext/java/duration.rb +142 -0
- data/lib/openhab/core_ext/java/list.rb +436 -0
- data/lib/openhab/core_ext/java/local_date.rb +104 -0
- data/lib/openhab/core_ext/java/local_time.rb +118 -0
- data/lib/openhab/core_ext/java/map.rb +66 -0
- data/lib/openhab/core_ext/java/month.rb +71 -0
- data/lib/openhab/core_ext/java/month_day.rb +119 -0
- data/lib/openhab/core_ext/java/period.rb +103 -0
- data/lib/openhab/core_ext/java/temporal_amount.rb +34 -0
- data/lib/openhab/core_ext/java/time.rb +62 -0
- data/lib/openhab/core_ext/java/unit.rb +15 -0
- data/lib/openhab/core_ext/java/zoned_date_time.rb +213 -0
- data/lib/openhab/core_ext/ruby/array.rb +21 -0
- data/lib/openhab/core_ext/ruby/date.rb +96 -0
- data/lib/openhab/core_ext/ruby/date_time.rb +55 -0
- data/lib/openhab/core_ext/ruby/module.rb +15 -0
- data/lib/openhab/core_ext/ruby/numeric.rb +195 -0
- data/lib/openhab/core_ext/ruby/range.rb +70 -0
- data/lib/openhab/core_ext/ruby/symbol.rb +7 -0
- data/lib/openhab/core_ext/ruby/time.rb +108 -0
- data/lib/openhab/core_ext.rb +18 -0
- data/lib/openhab/dsl/debouncer.rb +259 -0
- data/lib/openhab/dsl/events/watch_event.rb +18 -0
- data/lib/openhab/dsl/events.rb +9 -0
- data/lib/openhab/dsl/gems.rb +1 -1
- data/lib/openhab/dsl/items/builder.rb +578 -0
- data/lib/openhab/dsl/items/ensure.rb +73 -82
- data/lib/openhab/dsl/items/timed_command.rb +214 -159
- data/lib/openhab/dsl/rules/automation_rule.rb +129 -116
- data/lib/openhab/dsl/rules/builder.rb +1935 -0
- data/lib/openhab/dsl/rules/guard.rb +51 -114
- data/lib/openhab/dsl/rules/name_inference.rb +66 -25
- data/lib/openhab/dsl/rules/property.rb +48 -75
- data/lib/openhab/dsl/rules/rule_triggers.rb +22 -27
- data/lib/openhab/dsl/rules/terse.rb +58 -14
- data/lib/openhab/dsl/rules/triggers/changed.rb +48 -94
- data/lib/openhab/dsl/rules/triggers/channel.rb +9 -40
- data/lib/openhab/dsl/rules/triggers/command.rb +14 -63
- data/lib/openhab/dsl/rules/triggers/conditions/duration.rb +34 -69
- data/lib/openhab/dsl/rules/triggers/conditions/proc.rb +6 -14
- data/lib/openhab/dsl/rules/triggers/cron/cron.rb +48 -82
- data/lib/openhab/dsl/rules/triggers/cron/cron_handler.rb +30 -47
- data/lib/openhab/dsl/rules/triggers/trigger.rb +7 -28
- data/lib/openhab/dsl/rules/triggers/updated.rb +21 -45
- data/lib/openhab/dsl/rules/triggers/watch/watch_handler.rb +257 -102
- data/lib/openhab/dsl/rules/triggers.rb +12 -0
- data/lib/openhab/dsl/rules.rb +8 -0
- data/lib/openhab/dsl/things/builder.rb +299 -0
- data/lib/openhab/{core → dsl}/thread_local.rb +27 -17
- data/lib/openhab/dsl/timer_manager.rb +204 -0
- data/lib/openhab/dsl/version.rb +9 -0
- data/lib/openhab/dsl.rb +979 -0
- data/lib/openhab/log.rb +355 -0
- data/lib/openhab/osgi.rb +68 -0
- data/lib/openhab/rspec/configuration.rb +56 -0
- data/lib/openhab/rspec/example_group.rb +132 -0
- data/lib/openhab/rspec/helpers.rb +458 -0
- data/lib/openhab/rspec/hooks.rb +113 -0
- data/lib/openhab/rspec/jruby.rb +46 -0
- data/lib/openhab/rspec/karaf.rb +851 -0
- data/lib/openhab/rspec/mocks/bundle_install_support.rb +25 -0
- data/lib/openhab/rspec/mocks/bundle_resolver.rb +30 -0
- data/lib/openhab/rspec/mocks/event_admin.rb +146 -0
- data/lib/openhab/rspec/mocks/instance_method_stasher.rb +22 -0
- data/lib/openhab/rspec/mocks/persistence_service.rb +155 -0
- data/lib/openhab/rspec/mocks/safe_caller.rb +40 -0
- data/lib/openhab/rspec/mocks/space.rb +23 -0
- data/lib/openhab/rspec/mocks/synchronous_executor.rb +63 -0
- data/lib/openhab/rspec/mocks/thing_handler.rb +76 -0
- data/lib/openhab/rspec/mocks/timer.rb +134 -0
- data/lib/openhab/rspec/openhab/core/actions.rb +38 -0
- data/lib/openhab/rspec/openhab/core/items/proxy.rb +15 -0
- data/lib/openhab/rspec/openhab/core/things/proxy.rb +27 -0
- data/lib/openhab/rspec/shell.rb +31 -0
- data/lib/openhab/rspec/suspend_rules.rb +50 -0
- data/lib/openhab/rspec.rb +26 -0
- data/lib/openhab/yard/base_helper.rb +19 -0
- data/lib/openhab/yard/cli/stats.rb +23 -0
- data/lib/openhab/yard/code_objects/group_object.rb +23 -0
- data/lib/openhab/yard/code_objects/java/base.rb +31 -0
- data/lib/openhab/yard/code_objects/java/class_object.rb +11 -0
- data/lib/openhab/yard/code_objects/java/field_object.rb +15 -0
- data/lib/openhab/yard/code_objects/java/interface_object.rb +15 -0
- data/lib/openhab/yard/code_objects/java/package_object.rb +11 -0
- data/lib/openhab/yard/code_objects/java/proxy.rb +23 -0
- data/lib/openhab/yard/coderay.rb +17 -0
- data/lib/openhab/yard/handlers/jruby/base.rb +58 -0
- data/lib/openhab/yard/handlers/jruby/class_handler.rb +18 -0
- data/lib/openhab/yard/handlers/jruby/constant_handler.rb +18 -0
- data/lib/openhab/yard/handlers/jruby/java_import_handler.rb +30 -0
- data/lib/openhab/yard/handlers/jruby/mixin_handler.rb +23 -0
- data/lib/openhab/yard/html_helper.rb +78 -0
- data/lib/openhab/yard/markdown_helper.rb +148 -0
- data/lib/openhab/yard/tags/constant_directive.rb +20 -0
- data/lib/openhab/yard/tags/group_directive.rb +24 -0
- data/lib/openhab/yard/tags/library.rb +3 -0
- data/lib/openhab/yard.rb +38 -0
- metadata +476 -106
- data/lib/openhab/core/item_proxy.rb +0 -29
- data/lib/openhab/core/load_path.rb +0 -19
- data/lib/openhab/core/openhab_setup.rb +0 -29
- data/lib/openhab/core/osgi.rb +0 -58
- data/lib/openhab/core/services.rb +0 -24
- data/lib/openhab/dsl/actions.rb +0 -114
- data/lib/openhab/dsl/between.rb +0 -25
- data/lib/openhab/dsl/channel.rb +0 -43
- data/lib/openhab/dsl/dsl.rb +0 -59
- data/lib/openhab/dsl/group.rb +0 -54
- data/lib/openhab/dsl/imports.rb +0 -21
- data/lib/openhab/dsl/items/color_item.rb +0 -76
- data/lib/openhab/dsl/items/comparable_item.rb +0 -62
- data/lib/openhab/dsl/items/contact_item.rb +0 -41
- data/lib/openhab/dsl/items/date_time_item.rb +0 -65
- data/lib/openhab/dsl/items/dimmer_item.rb +0 -65
- data/lib/openhab/dsl/items/generic_item.rb +0 -229
- data/lib/openhab/dsl/items/group_item.rb +0 -127
- data/lib/openhab/dsl/items/item_equality.rb +0 -59
- data/lib/openhab/dsl/items/item_registry.rb +0 -54
- data/lib/openhab/dsl/items/items.rb +0 -109
- data/lib/openhab/dsl/items/location_item.rb +0 -59
- data/lib/openhab/dsl/items/metadata.rb +0 -326
- data/lib/openhab/dsl/items/number_item.rb +0 -17
- data/lib/openhab/dsl/items/numeric_item.rb +0 -87
- data/lib/openhab/dsl/items/persistence.rb +0 -307
- data/lib/openhab/dsl/items/player_item.rb +0 -58
- data/lib/openhab/dsl/items/rollershutter_item.rb +0 -51
- data/lib/openhab/dsl/items/semantics/enumerable.rb +0 -91
- data/lib/openhab/dsl/items/semantics.rb +0 -227
- data/lib/openhab/dsl/items/string_item.rb +0 -51
- data/lib/openhab/dsl/items/switch_item.rb +0 -70
- data/lib/openhab/dsl/monkey_patch/actions/actions.rb +0 -4
- data/lib/openhab/dsl/monkey_patch/actions/script_thing_actions.rb +0 -39
- data/lib/openhab/dsl/monkey_patch/events/events.rb +0 -7
- data/lib/openhab/dsl/monkey_patch/events/item_command.rb +0 -85
- data/lib/openhab/dsl/monkey_patch/events/item_event.rb +0 -28
- data/lib/openhab/dsl/monkey_patch/events/item_state.rb +0 -61
- data/lib/openhab/dsl/monkey_patch/events/item_state_changed.rb +0 -60
- data/lib/openhab/dsl/monkey_patch/events/thing_status_info.rb +0 -33
- data/lib/openhab/dsl/monkey_patch/java/java.rb +0 -4
- data/lib/openhab/dsl/monkey_patch/java/local_time.rb +0 -44
- data/lib/openhab/dsl/monkey_patch/java/time_extensions.rb +0 -50
- data/lib/openhab/dsl/monkey_patch/java/zoned_date_time.rb +0 -45
- data/lib/openhab/dsl/monkey_patch/ruby/number.rb +0 -104
- data/lib/openhab/dsl/monkey_patch/ruby/ruby.rb +0 -6
- data/lib/openhab/dsl/monkey_patch/ruby/string.rb +0 -47
- data/lib/openhab/dsl/monkey_patch/ruby/time.rb +0 -61
- data/lib/openhab/dsl/openhab.rb +0 -30
- data/lib/openhab/dsl/persistence.rb +0 -27
- data/lib/openhab/dsl/rules/item_event.rb +0 -19
- data/lib/openhab/dsl/rules/rule.rb +0 -160
- data/lib/openhab/dsl/rules/rule_config.rb +0 -147
- data/lib/openhab/dsl/rules/triggers/generic.rb +0 -31
- data/lib/openhab/dsl/rules/triggers/triggers.rb +0 -11
- data/lib/openhab/dsl/rules/triggers/watch/watch.rb +0 -81
- data/lib/openhab/dsl/states.rb +0 -89
- data/lib/openhab/dsl/things.rb +0 -147
- data/lib/openhab/dsl/time/month_day.rb +0 -180
- data/lib/openhab/dsl/time/time_of_day.rb +0 -235
- data/lib/openhab/dsl/timers/manager.rb +0 -119
- data/lib/openhab/dsl/timers/reentrant_timer.rb +0 -38
- data/lib/openhab/dsl/timers/timer.rb +0 -132
- data/lib/openhab/dsl/timers.rb +0 -77
- data/lib/openhab/dsl/types/increase_decrease_type.rb +0 -23
- data/lib/openhab/dsl/types/next_previous_type.rb +0 -23
- data/lib/openhab/dsl/types/on_off_type.rb +0 -28
- data/lib/openhab/dsl/types/open_closed_type.rb +0 -29
- data/lib/openhab/dsl/types/play_pause_type.rb +0 -27
- data/lib/openhab/dsl/types/point_type.rb +0 -180
- data/lib/openhab/dsl/types/quantity_type.rb +0 -265
- data/lib/openhab/dsl/types/refresh_type.rb +0 -18
- data/lib/openhab/dsl/types/rewind_fastforward_type.rb +0 -33
- data/lib/openhab/dsl/types/stop_move_type.rb +0 -23
- data/lib/openhab/dsl/types/types.rb +0 -83
- data/lib/openhab/dsl/types/un_def_type.rb +0 -22
- data/lib/openhab/dsl/types/up_down_type.rb +0 -32
- data/lib/openhab/dsl/units.rb +0 -45
- data/lib/openhab/log/configuration.rb +0 -21
- data/lib/openhab/log/logger.rb +0 -282
- data/lib/openhab/version.rb +0 -9
- data/lib/openhab.rb +0 -38
@@ -0,0 +1,78 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "nokogiri"
|
4
|
+
|
5
|
+
module OpenHAB
|
6
|
+
module YARD
|
7
|
+
# @!visibility private
|
8
|
+
module HtmlHelper
|
9
|
+
def base_url
|
10
|
+
if serializer.is_a?(::YARD::Server::DocServerSerializer)
|
11
|
+
abs_url(base_path(router.docs_prefix), "")
|
12
|
+
else
|
13
|
+
u = url_for("")
|
14
|
+
u = "#{u}/" if !u.empty? && u[-1] != "/"
|
15
|
+
u
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
def url_for_search_index
|
20
|
+
if serializer.is_a?(::YARD::Server::DocServerSerializer)
|
21
|
+
url_for_list("index")
|
22
|
+
else
|
23
|
+
url_for("index.json")
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
def html_markup_markdown(text)
|
28
|
+
result = super(text)
|
29
|
+
|
30
|
+
html = Nokogiri::HTML5.fragment(result)
|
31
|
+
# re-link files in docs/*.md. They're written so they work on github without any
|
32
|
+
# processing
|
33
|
+
unless serializer.is_a?(::YARD::Server::DocServerSerializer)
|
34
|
+
html.css("a[href!='']").each do |link|
|
35
|
+
uri = URI.parse(link["href"])
|
36
|
+
next unless uri.relative? && File.extname(uri.path) == ".md"
|
37
|
+
|
38
|
+
basename = File.basename(uri.path, ".md")
|
39
|
+
uri.path = "file.#{basename}.html"
|
40
|
+
link["href"] = uri.to_s
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
# wtf commonmarker, you don't generate anchors?!
|
45
|
+
html.css("h1, h2, h3, h4, h5, h6").each do |header|
|
46
|
+
next if header["id"]
|
47
|
+
|
48
|
+
id = header.text.strip.downcase.delete(%(.?"')).gsub(/[ ,]+/, "-")
|
49
|
+
header["id"] = id
|
50
|
+
header.prepend_child(%(<a href="##{id}" class="header-anchor">#</a>))
|
51
|
+
end
|
52
|
+
|
53
|
+
html.to_s
|
54
|
+
end
|
55
|
+
|
56
|
+
def link_url(url, title = nil, params = {})
|
57
|
+
params.merge!(@link_attrs) if defined?(@link_attrs) && @link_attrs
|
58
|
+
params[:class] = params.delete(:classes).join(" ") if params[:classes]
|
59
|
+
super
|
60
|
+
end
|
61
|
+
|
62
|
+
# have to completely replace this method. only change is the regex splitting
|
63
|
+
# into parts now allows `.` as part of the identifier
|
64
|
+
# rubocop:disable Style/NestedTernaryOperator, Style/StringConcatenation, Style/TernaryParentheses
|
65
|
+
def format_types(typelist, brackets = true) # rubocop:disable Style/OptionalBooleanParameter
|
66
|
+
return unless typelist.is_a?(Array)
|
67
|
+
|
68
|
+
list = typelist.map do |type|
|
69
|
+
type = type.gsub(/([<>])/) { h($1) }
|
70
|
+
type = type.gsub(/([\w:.]+)/) { $1 == "lt" || $1 == "gt" ? $1 : linkify($1, $1) }
|
71
|
+
"<tt>" + type + "</tt>"
|
72
|
+
end
|
73
|
+
list.empty? ? "" : (brackets ? "(#{list.join(", ")})" : list.join(", "))
|
74
|
+
end
|
75
|
+
# rubocop:enable Style/NestedTernaryOperator, Style/StringConcatenation, Style/TernaryParentheses
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
@@ -0,0 +1,148 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module OpenHAB
|
4
|
+
module YARD
|
5
|
+
# @!visibility private
|
6
|
+
module MarkdownHelper
|
7
|
+
include ::YARD::Templates::Helpers::HtmlHelper
|
8
|
+
# @group Linking Objects and URLs
|
9
|
+
|
10
|
+
def diskfile
|
11
|
+
resolve_links(super)
|
12
|
+
end
|
13
|
+
|
14
|
+
# mostly copied from HTMLHelper
|
15
|
+
def resolve_links(text)
|
16
|
+
blockquotes = false
|
17
|
+
result = text.gsub(%r{(```)|(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=[\W<]|.+</|$)}m) do |str|
|
18
|
+
blockquote = $1
|
19
|
+
escape = $2
|
20
|
+
name = $3
|
21
|
+
title = $4
|
22
|
+
match = $&
|
23
|
+
if blockquote
|
24
|
+
blockquotes = !blockquotes
|
25
|
+
next str
|
26
|
+
end
|
27
|
+
next str if blockquotes
|
28
|
+
|
29
|
+
next(match[1..]) if escape
|
30
|
+
|
31
|
+
next(match) if name[0, 1] == "|"
|
32
|
+
|
33
|
+
if object.is_a?(String)
|
34
|
+
object
|
35
|
+
else
|
36
|
+
link = linkify(name, title)
|
37
|
+
if (link == name || link == title) && ("#{name} #{link}" !~ /\A<a\s.*>/)
|
38
|
+
match = /(.+)?(\{#{Regexp.quote name}(?:\s.*?)?\})(.+)?/.match(text)
|
39
|
+
file = ((defined?(@file) && @file) ? @file.filename : object.file) || "(unknown)"
|
40
|
+
line = (if defined?(@file) && @file
|
41
|
+
1
|
42
|
+
else
|
43
|
+
(object.docstring.line_range ? object.docstring.line_range.first : 1)
|
44
|
+
end) + (match ? $`.count("\n") : 0)
|
45
|
+
if match
|
46
|
+
log.warn "In file `#{file}':#{line}: Cannot resolve link to #{name} from text#{match ? ":" : "."}\n" \
|
47
|
+
"\t#{match[1] ? "..." : ""}#{match[2].delete("\n")}#{match[3] ? "..." : ""}"
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
link
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
# re-link files in docs/*.md. They're written so they work on github without any
|
56
|
+
# processing
|
57
|
+
result.gsub!(%r{\[([A-Za-z0-9,. ]+)\]\(([A-Za-z0-9./-]+)\)}) do |str|
|
58
|
+
title = $1
|
59
|
+
target = $2
|
60
|
+
next str unless File.dirname(target) == "docs" && File.extname(target) == ".md"
|
61
|
+
|
62
|
+
basename = File.basename(target, ".md")
|
63
|
+
"[#{title}](#{serializer.basepath}/file.#{basename}.html)"
|
64
|
+
end
|
65
|
+
|
66
|
+
result
|
67
|
+
end
|
68
|
+
|
69
|
+
# mostly copied from HTMLHelper
|
70
|
+
def link_object(obj, title = nil, anchor = nil, relative = true) # rubocop:disable Style/OptionalBooleanParameter
|
71
|
+
return title if obj.nil?
|
72
|
+
|
73
|
+
obj = ::YARD::Registry.resolve(object, obj, true, true) if obj.is_a?(String)
|
74
|
+
|
75
|
+
was_const = false
|
76
|
+
# Re-link references to constants that are aliases to their target. But keep
|
77
|
+
# their current title.
|
78
|
+
while obj.is_a?(::YARD::CodeObjects::ConstantObject) && obj.target
|
79
|
+
title ||= h(object.relative_path(obj)).to_s
|
80
|
+
was_const = true
|
81
|
+
obj = obj.target
|
82
|
+
end
|
83
|
+
return link_object(obj, title, anchor, relative) if was_const
|
84
|
+
|
85
|
+
title = if title
|
86
|
+
title.to_s
|
87
|
+
elsif object.is_a?(::YARD::CodeObjects::Base)
|
88
|
+
# Check if we're linking to a class method in the current
|
89
|
+
# object. If we are, create a title in the format of
|
90
|
+
# "CurrentClass.method_name"
|
91
|
+
if obj.is_a?(::YARD::CodeObjects::MethodObject) && obj.scope == :class && obj.parent == object
|
92
|
+
h([object.name, obj.sep, obj.name].join)
|
93
|
+
elsif obj.title != obj.path
|
94
|
+
h(obj.title)
|
95
|
+
else
|
96
|
+
h(object.relative_path(obj))
|
97
|
+
end
|
98
|
+
else
|
99
|
+
h(obj.title)
|
100
|
+
end
|
101
|
+
return title unless serializer
|
102
|
+
return title if obj.is_a?(::YARD::CodeObjects::Proxy)
|
103
|
+
|
104
|
+
link = url_for(obj, anchor, relative)
|
105
|
+
link ? link_url(link, title, title: h("#{obj.title} (#{obj.type})")) : title
|
106
|
+
rescue ::YARD::Parser::UndocumentableError
|
107
|
+
log.warn "The namespace of link #{obj.inspect} is a constant or invalid."
|
108
|
+
title || obj.to_s
|
109
|
+
end
|
110
|
+
|
111
|
+
def url_for(obj, anchor = nil, relative = true) # rubocop:disable Style/OptionalBooleanParameter
|
112
|
+
link = nil
|
113
|
+
return link unless serializer
|
114
|
+
return link if obj.is_a?(::YARD::CodeObjects::Base) && run_verifier([obj]).empty?
|
115
|
+
|
116
|
+
if obj.is_a?(::YARD::CodeObjects::Base) && !obj.is_a?(::YARD::CodeObjects::NamespaceObject)
|
117
|
+
# If the obj is not a namespace obj make it the anchor.
|
118
|
+
anchor = obj
|
119
|
+
obj = obj.namespace
|
120
|
+
end
|
121
|
+
|
122
|
+
objpath = serializer.serialized_path(obj)
|
123
|
+
return link unless objpath
|
124
|
+
|
125
|
+
relative = false if object == ::YARD::Registry.root
|
126
|
+
if relative
|
127
|
+
fromobj = object
|
128
|
+
if object.is_a?(::YARD::CodeObjects::Base) &&
|
129
|
+
!object.is_a?(::YARD::CodeObjects::NamespaceObject)
|
130
|
+
fromobj = owner
|
131
|
+
end
|
132
|
+
|
133
|
+
from = serializer.serialized_path(fromobj)
|
134
|
+
link = File.relative_path(from, objpath)
|
135
|
+
else
|
136
|
+
link = File.join(serializer.basepath, objpath)
|
137
|
+
end
|
138
|
+
|
139
|
+
link + (anchor ? "##{urlencode(anchor_for(anchor))}" : "")
|
140
|
+
end
|
141
|
+
|
142
|
+
def link_url(url, title = nil, _params = nil)
|
143
|
+
title ||= url
|
144
|
+
"[#{title}](#{url})"
|
145
|
+
end
|
146
|
+
end
|
147
|
+
end
|
148
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module OpenHAB
|
4
|
+
module YARD
|
5
|
+
module Tags
|
6
|
+
class ConstantDirective < ::YARD::Tags::Directive
|
7
|
+
def call
|
8
|
+
return unless handler
|
9
|
+
|
10
|
+
::YARD::CodeObjects::ConstantObject.new(handler.namespace, tag.name.to_sym) do |obj|
|
11
|
+
obj.value = ""
|
12
|
+
obj.docstring = tag.text
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
::YARD::Tags::Library.define_directive :constant, :with_title_and_text, self
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module OpenHAB
|
4
|
+
module YARD
|
5
|
+
module Tags
|
6
|
+
module GroupDirective
|
7
|
+
::YARD::Tags::GroupDirective.prepend(self)
|
8
|
+
|
9
|
+
def after_parse
|
10
|
+
return if tag.name.empty?
|
11
|
+
return unless handler
|
12
|
+
|
13
|
+
object = CodeObjects::GroupObject.new(handler.namespace, tag.name)
|
14
|
+
handler.extra_state.group = object
|
15
|
+
self.parser = parser.class.new(parser.library)
|
16
|
+
parser.state.inside_directive = true
|
17
|
+
parser.parse(tag.text, object, handler)
|
18
|
+
parser.state.inside_directive = false
|
19
|
+
object.docstring = parser.to_docstring # rubocop:disable Lint/UselessSetterCall
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
data/lib/openhab/yard.rb
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "byebug"
|
4
|
+
|
5
|
+
Dir[File.expand_path("yard/**/*.rb", __dir__)].sort.each do |f|
|
6
|
+
require f
|
7
|
+
end
|
8
|
+
|
9
|
+
YARD::Templates::Template.extra_includes << OpenHAB::YARD::BaseHelper
|
10
|
+
YARD::Templates::Template.extra_includes << ->(opts) { OpenHAB::YARD::CodeRay::HtmlHelper if opts.format == :html }
|
11
|
+
YARD::Templates::Template.extra_includes << ->(opts) { OpenHAB::YARD::HtmlHelper if opts.format == :html }
|
12
|
+
YARD::Templates::Template.extra_includes << ->(opts) { OpenHAB::YARD::MarkdownHelper if opts.format == :markdown }
|
13
|
+
|
14
|
+
YARD::Templates::Engine.register_template_path File.expand_path("../../templates", __dir__)
|
15
|
+
YARD::Tags::Library.define_tag "Java Interface", :interface
|
16
|
+
|
17
|
+
YARD::Server.register_static_path(".")
|
18
|
+
|
19
|
+
#
|
20
|
+
# @!parse
|
21
|
+
# # @!visibility private
|
22
|
+
# module Comparable; end
|
23
|
+
#
|
24
|
+
# # @!visibility private
|
25
|
+
# module Forwardable; end
|
26
|
+
#
|
27
|
+
# # @!visibility private
|
28
|
+
# module Singleton; end
|
29
|
+
#
|
30
|
+
# # Extensions to Ruby Numeric
|
31
|
+
# class Numeric; end
|
32
|
+
#
|
33
|
+
# # @!visibility private
|
34
|
+
# class Object; end
|
35
|
+
#
|
36
|
+
# # Extensions to Ruby Range
|
37
|
+
# class Range; end
|
38
|
+
#
|