inch 0.5.2 → 0.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/lib/inch/language/elixir/provider/reader/object/module_object.rb +3 -1
  4. data/lib/inch/version.rb +1 -1
  5. data/test/fixtures/elixir/inch_test/all.json +835 -68
  6. data/test/unit/language/elixir/code_object/module_object_test.rb +25 -0
  7. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 4c430836d9e77d663202c817594fdea71b13e94c
4
- data.tar.gz: 9dc7dead07119bdbf0ddbd98c14f3f3604acd262
3
+ metadata.gz: 134df9a58b6c94acbea3a40e9c13a1866dad4ba3
4
+ data.tar.gz: 86f583e22f1efba67e99a541d7d3aa7831845672
5
5
  SHA512:
6
- metadata.gz: df94b22d6860ec87ddfcf68df57f6dc82e6b99e77b4bf713f74e8e3e9243cbd089bc8e5720c2db12a3c333e8db7d1be4a5bcbb541a79874cba4d68f60a381f79
7
- data.tar.gz: 54c90ae79aaa7141ab6f9c2ea6dbe15a0dcf0562e3b13f60a8164c9d61b8ba57d17d00ba8dd35164454016cd40a5cb5768df00bccba49cd88fc02cb23ab2bd31
6
+ metadata.gz: 06c80b30becf6922f37fef61ebb2d9086a4f593d4e3ef57f2ed7a803b8031e6021157003f30bf21aa86d7d4340f487a0b0adfbcdf0adbff03227cc191379e262
7
+ data.tar.gz: 3859356b25d2bc894ce88653fb60c94c95869e583176f4d96f89710bd7f81660c0968ecb71fa3f90eabc2f06513e97b175a8f4c953472f1d9c520cd6f9173a74
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.5.3
4
+
5
+ - Elixir: Hide implementations of protocols
6
+
7
+ ## 0.5.2
8
+
9
+ - Elixir: Fix bug related to @moduledoc
10
+
11
+ ## 0.5.1
12
+
13
+ - Fix bug related to reading dumps
14
+
3
15
  ## 0.5.0
4
16
 
5
17
  - Multi-language support was added
data/lib/inch/language/elixir/provider/reader/object/module_object.rb CHANGED
@@ -10,8 +10,10 @@ module Inch
10
10
  @hash['moduledoc']
11
11
  end
12
12
 
13
+ HIDDEN_TYPES = %w(impl)
13
14
  def nodoc?
14
- super || @hash['moduledoc'] == false
15
+ @hash['moduledoc'] == false ||
16
+ HIDDEN_TYPES.include?(@hash['type'])
15
17
  end
16
18
 
17
19
  def fullname
data/lib/inch/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Inch
2
- VERSION = '0.5.2'
2
+ VERSION = '0.5.3'
3
3
  end
data/test/fixtures/elixir/inch_test/all.json CHANGED
@@ -1,8 +1,5 @@
1
1
  {
2
- "args": [
3
- "inspect",
4
- "InchTest.Functions."
5
- ],
2
+ "args": [],
6
3
  "git_repo_url": "git@github.com:inch-ci/Hello-World-Elixir.git",
7
4
  "language": "elixir",
8
5
  "objects": [
@@ -78,6 +75,80 @@
78
75
  "type": null,
79
76
  "typespecs": []
80
77
  },
78
+ {
79
+ "id": "InchTest.Html",
80
+ "module": "Elixir.InchTest.Html",
81
+ "moduledoc": null,
82
+ "object_type": "ModuleObject",
83
+ "source": null,
84
+ "type": null,
85
+ "typespecs": []
86
+ },
87
+ {
88
+ "id": "InchTest.Html.Safe",
89
+ "module": "Elixir.InchTest.Html.Safe",
90
+ "moduledoc": null,
91
+ "object_type": "ModuleObject",
92
+ "source": null,
93
+ "type": "protocol",
94
+ "typespecs": [
95
+ "[Elixir.Any]"
96
+ ]
97
+ },
98
+ {
99
+ "id": "InchTest.Html.Safe.Atom",
100
+ "module": "Elixir.InchTest.Html.Safe.Atom",
101
+ "moduledoc": null,
102
+ "object_type": "ModuleObject",
103
+ "source": null,
104
+ "type": "impl",
105
+ "typespecs": []
106
+ },
107
+ {
108
+ "id": "InchTest.Html.Safe.BitString",
109
+ "module": "Elixir.InchTest.Html.Safe.BitString",
110
+ "moduledoc": null,
111
+ "object_type": "ModuleObject",
112
+ "source": null,
113
+ "type": "impl",
114
+ "typespecs": []
115
+ },
116
+ {
117
+ "id": "InchTest.Html.Safe.Float",
118
+ "module": "Elixir.InchTest.Html.Safe.Float",
119
+ "moduledoc": null,
120
+ "object_type": "ModuleObject",
121
+ "source": null,
122
+ "type": "impl",
123
+ "typespecs": []
124
+ },
125
+ {
126
+ "id": "InchTest.Html.Safe.Integer",
127
+ "module": "Elixir.InchTest.Html.Safe.Integer",
128
+ "moduledoc": null,
129
+ "object_type": "ModuleObject",
130
+ "source": null,
131
+ "type": "impl",
132
+ "typespecs": []
133
+ },
134
+ {
135
+ "id": "InchTest.Html.Safe.List",
136
+ "module": "Elixir.InchTest.Html.Safe.List",
137
+ "moduledoc": null,
138
+ "object_type": "ModuleObject",
139
+ "source": null,
140
+ "type": "impl",
141
+ "typespecs": []
142
+ },
143
+ {
144
+ "id": "InchTest.Html.Safe.Tuple",
145
+ "module": "Elixir.InchTest.Html.Safe.Tuple",
146
+ "moduledoc": null,
147
+ "object_type": "ModuleObject",
148
+ "source": null,
149
+ "type": "impl",
150
+ "typespecs": []
151
+ },
81
152
  {
82
153
  "id": "InchTest.ModuleObject",
83
154
  "module": "Elixir.InchTest.ModuleObject",
@@ -441,16 +512,16 @@
441
512
  },
442
513
  {
443
514
  "arity": 1,
444
- "doc": "Converts String to camel case\n\n## Examples\n\n iex> InchTest.Naming.camelize(\"my_app\")\n \"MyApp\"\n\nIn general, `camelize` can be thought of as the reverse of\n`underscore`, however, in some cases formatting may be lost:\n\n InchTest.Naming.underscore \"SAPExample\" #=> \"sap_example\"\n InchTest.Naming.camelize \"sap_example\" #=> \"SapExample\"\n\n",
445
- "id": "camelize/1",
446
- "module_id": "InchTest.Naming",
447
- "name": "camelize",
515
+ "doc": null,
516
+ "id": "escape/1",
517
+ "module_id": "InchTest.Html",
518
+ "name": "escape",
448
519
  "object_type": "FunctionObject",
449
520
  "signature": [
450
521
  [
451
- "arg1",
522
+ "buffer",
452
523
  [],
453
- "Elixir"
524
+ null
454
525
  ]
455
526
  ],
456
527
  "source": null,
@@ -460,15 +531,15 @@
460
531
  {
461
532
  "arity": 1,
462
533
  "doc": null,
463
- "id": "do_camelize/1",
464
- "module_id": "InchTest.Naming",
465
- "name": "do_camelize",
534
+ "id": "safe/1",
535
+ "module_id": "InchTest.Html",
536
+ "name": "safe",
466
537
  "object_type": "FunctionObject",
467
538
  "signature": [
468
539
  [
469
- "arg1",
540
+ "value",
470
541
  [],
471
- "Elixir"
542
+ null
472
543
  ]
473
544
  ],
474
545
  "source": null,
@@ -476,20 +547,15 @@
476
547
  "type": "def"
477
548
  },
478
549
  {
479
- "arity": 2,
550
+ "arity": 1,
480
551
  "doc": null,
481
- "id": "do_underscore/2",
482
- "module_id": "InchTest.Naming",
483
- "name": "do_underscore",
552
+ "id": "unsafe/1",
553
+ "module_id": "InchTest.Html",
554
+ "name": "unsafe",
484
555
  "object_type": "FunctionObject",
485
556
  "signature": [
486
557
  [
487
- "arg1",
488
- [],
489
- "Elixir"
490
- ],
491
- [
492
- "prev",
558
+ "value",
493
559
  [],
494
560
  null
495
561
  ]
@@ -499,20 +565,88 @@
499
565
  "type": "def"
500
566
  },
501
567
  {
502
- "arity": 2,
503
- "doc": null,
504
- "id": "remove_suffix/2",
505
- "module_id": "InchTest.Naming",
506
- "name": "remove_suffix",
568
+ "arity": 1,
569
+ "doc": false,
570
+ "id": "__protocol__/1",
571
+ "module_id": "InchTest.Html.Safe",
572
+ "name": "__protocol__",
507
573
  "object_type": "FunctionObject",
508
574
  "signature": [
509
575
  [
510
- "alias",
576
+ "atom1",
511
577
  [],
512
- null
578
+ "Elixir"
579
+ ]
580
+ ],
581
+ "source": null,
582
+ "specs": [
583
+ [
584
+ "::",
585
+ {
586
+ "line": 19
587
+ },
588
+ [
589
+ [
590
+ "__protocol__",
591
+ {
592
+ "line": 19
593
+ },
594
+ [
595
+ "functions"
596
+ ]
597
+ ],
598
+ [
599
+ [
600
+ "{}",
601
+ {
602
+ "line": 0
603
+ },
604
+ [
605
+ "to_string",
606
+ 1
607
+ ]
608
+ ],
609
+ [
610
+ "...",
611
+ {
612
+ "line": 0
613
+ },
614
+ null
615
+ ]
616
+ ]
617
+ ]
513
618
  ],
514
619
  [
515
- "suffix",
620
+ "::",
621
+ {
622
+ "line": 19
623
+ },
624
+ [
625
+ [
626
+ "__protocol__",
627
+ {
628
+ "line": 19
629
+ },
630
+ [
631
+ "name"
632
+ ]
633
+ ],
634
+ "Elixir.InchTest.Html.Safe"
635
+ ]
636
+ ]
637
+ ],
638
+ "type": "def"
639
+ },
640
+ {
641
+ "arity": 1,
642
+ "doc": null,
643
+ "id": "to_string/1",
644
+ "module_id": "InchTest.Html.Safe",
645
+ "name": "to_string",
646
+ "object_type": "FunctionObject",
647
+ "signature": [
648
+ [
649
+ "data",
516
650
  [],
517
651
  null
518
652
  ]
@@ -522,45 +656,88 @@
522
656
  "type": "def"
523
657
  },
524
658
  {
525
- "arity": 2,
526
- "doc": "Extracts the resource name from an alias\n\n## Examples\n\n iex> InchTest.Naming.resource_name(MyApp.User)\n \"user\"\n iex> InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n \"user\"\n\n",
527
- "id": "resource_name/2",
528
- "module_id": "InchTest.Naming",
529
- "name": "resource_name",
659
+ "arity": 1,
660
+ "doc": false,
661
+ "id": "__impl__/1",
662
+ "module_id": "InchTest.Html.Safe.Atom",
663
+ "name": "__impl__",
530
664
  "object_type": "FunctionObject",
531
665
  "signature": [
532
666
  [
533
- "alias",
667
+ "atom1",
534
668
  [],
535
- null
669
+ "Elixir"
670
+ ]
671
+ ],
672
+ "source": null,
673
+ "specs": [
674
+ [
675
+ "::",
676
+ {
677
+ "line": 23
678
+ },
679
+ [
680
+ [
681
+ "__impl__",
682
+ {
683
+ "line": 23
684
+ },
685
+ [
686
+ "protocol"
687
+ ]
688
+ ],
689
+ "Elixir.InchTest.Html.Safe"
690
+ ]
536
691
  ],
537
692
  [
538
- "\\\\",
539
- [],
693
+ "::",
694
+ {
695
+ "line": 23
696
+ },
540
697
  [
541
698
  [
542
- "suffix",
543
- [],
544
- null
699
+ "__impl__",
700
+ {
701
+ "line": 23
702
+ },
703
+ [
704
+ "target"
705
+ ]
545
706
  ],
546
- null
707
+ "Elixir.InchTest.Html.Safe.Atom"
708
+ ]
709
+ ],
710
+ [
711
+ "::",
712
+ {
713
+ "line": 23
714
+ },
715
+ [
716
+ [
717
+ "__impl__",
718
+ {
719
+ "line": 23
720
+ },
721
+ [
722
+ "for"
723
+ ]
724
+ ],
725
+ "Elixir.Atom"
547
726
  ]
548
727
  ]
549
728
  ],
550
- "source": null,
551
- "specs": [],
552
729
  "type": "def"
553
730
  },
554
731
  {
555
732
  "arity": 1,
556
- "doc": null,
557
- "id": "to_lower_char/1",
558
- "module_id": "InchTest.Naming",
559
- "name": "to_lower_char",
733
+ "doc": "Callback implementation of `InchTest.Html.Safe.to_string/1`.",
734
+ "id": "to_string/1",
735
+ "module_id": "InchTest.Html.Safe.Atom",
736
+ "name": "to_string",
560
737
  "object_type": "FunctionObject",
561
738
  "signature": [
562
739
  [
563
- "char",
740
+ "atom",
564
741
  [],
565
742
  null
566
743
  ]
@@ -571,39 +748,629 @@
571
748
  },
572
749
  {
573
750
  "arity": 1,
574
- "doc": null,
575
- "id": "to_upper_char/1",
576
- "module_id": "InchTest.Naming",
577
- "name": "to_upper_char",
751
+ "doc": false,
752
+ "id": "__impl__/1",
753
+ "module_id": "InchTest.Html.Safe.BitString",
754
+ "name": "__impl__",
578
755
  "object_type": "FunctionObject",
579
756
  "signature": [
580
757
  [
581
- "char",
758
+ "atom1",
582
759
  [],
583
- null
760
+ "Elixir"
584
761
  ]
585
762
  ],
586
763
  "source": null,
587
- "specs": [],
764
+ "specs": [
765
+ [
766
+ "::",
767
+ {
768
+ "line": 28
769
+ },
770
+ [
771
+ [
772
+ "__impl__",
773
+ {
774
+ "line": 28
775
+ },
776
+ [
777
+ "protocol"
778
+ ]
779
+ ],
780
+ "Elixir.InchTest.Html.Safe"
781
+ ]
782
+ ],
783
+ [
784
+ "::",
785
+ {
786
+ "line": 28
787
+ },
788
+ [
789
+ [
790
+ "__impl__",
791
+ {
792
+ "line": 28
793
+ },
794
+ [
795
+ "target"
796
+ ]
797
+ ],
798
+ "Elixir.InchTest.Html.Safe.BitString"
799
+ ]
800
+ ],
801
+ [
802
+ "::",
803
+ {
804
+ "line": 28
805
+ },
806
+ [
807
+ [
808
+ "__impl__",
809
+ {
810
+ "line": 28
811
+ },
812
+ [
813
+ "for"
814
+ ]
815
+ ],
816
+ "Elixir.BitString"
817
+ ]
818
+ ]
819
+ ],
588
820
  "type": "def"
589
821
  },
590
822
  {
591
823
  "arity": 1,
592
- "doc": "Converts String to underscore case\n\n## Examples\n\n iex> InchTest.Naming.underscore(\"MyApp\")\n \"my_app\"\n\n iex> InchTest.Naming.underscore(\"my-app\")\n \"my_app\"\n\nIn general, `underscore` can be thought of as the reverse of\n`camelize`, however, in some cases formatting may be lost:\n\n Naming.underscore \"SAPExample\" #=> \"sap_example\"\n Naming.camelize \"sap_example\" #=> \"SapExample\"\n\n",
593
- "id": "underscore/1",
594
- "module_id": "InchTest.Naming",
595
- "name": "underscore",
824
+ "doc": "Callback implementation of `InchTest.Html.Safe.to_string/1`.",
825
+ "id": "to_string/1",
826
+ "module_id": "InchTest.Html.Safe.BitString",
827
+ "name": "to_string",
596
828
  "object_type": "FunctionObject",
597
829
  "signature": [
598
830
  [
599
- "arg1",
831
+ "data",
600
832
  [],
601
- "Elixir"
833
+ null
602
834
  ]
603
835
  ],
604
836
  "source": null,
605
837
  "specs": [],
606
838
  "type": "def"
607
- }
608
- ]
839
+ },
840
+ {
841
+ "arity": 1,
842
+ "doc": false,
843
+ "id": "__impl__/1",
844
+ "module_id": "InchTest.Html.Safe.Float",
845
+ "name": "__impl__",
846
+ "object_type": "FunctionObject",
847
+ "signature": [
848
+ [
849
+ "atom1",
850
+ [],
851
+ "Elixir"
852
+ ]
853
+ ],
854
+ "source": null,
855
+ "specs": [
856
+ [
857
+ "::",
858
+ {
859
+ "line": 66
860
+ },
861
+ [
862
+ [
863
+ "__impl__",
864
+ {
865
+ "line": 66
866
+ },
867
+ [
868
+ "protocol"
869
+ ]
870
+ ],
871
+ "Elixir.InchTest.Html.Safe"
872
+ ]
873
+ ],
874
+ [
875
+ "::",
876
+ {
877
+ "line": 66
878
+ },
879
+ [
880
+ [
881
+ "__impl__",
882
+ {
883
+ "line": 66
884
+ },
885
+ [
886
+ "target"
887
+ ]
888
+ ],
889
+ "Elixir.InchTest.Html.Safe.Float"
890
+ ]
891
+ ],
892
+ [
893
+ "::",
894
+ {
895
+ "line": 66
896
+ },
897
+ [
898
+ [
899
+ "__impl__",
900
+ {
901
+ "line": 66
902
+ },
903
+ [
904
+ "for"
905
+ ]
906
+ ],
907
+ "Elixir.Float"
908
+ ]
909
+ ]
910
+ ],
911
+ "type": "def"
912
+ },
913
+ {
914
+ "arity": 1,
915
+ "doc": "Callback implementation of `InchTest.Html.Safe.to_string/1`.",
916
+ "id": "to_string/1",
917
+ "module_id": "InchTest.Html.Safe.Float",
918
+ "name": "to_string",
919
+ "object_type": "FunctionObject",
920
+ "signature": [
921
+ [
922
+ "data",
923
+ [],
924
+ null
925
+ ]
926
+ ],
927
+ "source": null,
928
+ "specs": [],
929
+ "type": "def"
930
+ },
931
+ {
932
+ "arity": 1,
933
+ "doc": false,
934
+ "id": "__impl__/1",
935
+ "module_id": "InchTest.Html.Safe.Integer",
936
+ "name": "__impl__",
937
+ "object_type": "FunctionObject",
938
+ "signature": [
939
+ [
940
+ "atom1",
941
+ [],
942
+ "Elixir"
943
+ ]
944
+ ],
945
+ "source": null,
946
+ "specs": [
947
+ [
948
+ "::",
949
+ {
950
+ "line": 62
951
+ },
952
+ [
953
+ [
954
+ "__impl__",
955
+ {
956
+ "line": 62
957
+ },
958
+ [
959
+ "protocol"
960
+ ]
961
+ ],
962
+ "Elixir.InchTest.Html.Safe"
963
+ ]
964
+ ],
965
+ [
966
+ "::",
967
+ {
968
+ "line": 62
969
+ },
970
+ [
971
+ [
972
+ "__impl__",
973
+ {
974
+ "line": 62
975
+ },
976
+ [
977
+ "target"
978
+ ]
979
+ ],
980
+ "Elixir.InchTest.Html.Safe.Integer"
981
+ ]
982
+ ],
983
+ [
984
+ "::",
985
+ {
986
+ "line": 62
987
+ },
988
+ [
989
+ [
990
+ "__impl__",
991
+ {
992
+ "line": 62
993
+ },
994
+ [
995
+ "for"
996
+ ]
997
+ ],
998
+ "Elixir.Integer"
999
+ ]
1000
+ ]
1001
+ ],
1002
+ "type": "def"
1003
+ },
1004
+ {
1005
+ "arity": 1,
1006
+ "doc": "Callback implementation of `InchTest.Html.Safe.to_string/1`.",
1007
+ "id": "to_string/1",
1008
+ "module_id": "InchTest.Html.Safe.Integer",
1009
+ "name": "to_string",
1010
+ "object_type": "FunctionObject",
1011
+ "signature": [
1012
+ [
1013
+ "data",
1014
+ [],
1015
+ null
1016
+ ]
1017
+ ],
1018
+ "source": null,
1019
+ "specs": [],
1020
+ "type": "def"
1021
+ },
1022
+ {
1023
+ "arity": 1,
1024
+ "doc": false,
1025
+ "id": "__impl__/1",
1026
+ "module_id": "InchTest.Html.Safe.List",
1027
+ "name": "__impl__",
1028
+ "object_type": "FunctionObject",
1029
+ "signature": [
1030
+ [
1031
+ "atom1",
1032
+ [],
1033
+ "Elixir"
1034
+ ]
1035
+ ],
1036
+ "source": null,
1037
+ "specs": [
1038
+ [
1039
+ "::",
1040
+ {
1041
+ "line": 34
1042
+ },
1043
+ [
1044
+ [
1045
+ "__impl__",
1046
+ {
1047
+ "line": 34
1048
+ },
1049
+ [
1050
+ "protocol"
1051
+ ]
1052
+ ],
1053
+ "Elixir.InchTest.Html.Safe"
1054
+ ]
1055
+ ],
1056
+ [
1057
+ "::",
1058
+ {
1059
+ "line": 34
1060
+ },
1061
+ [
1062
+ [
1063
+ "__impl__",
1064
+ {
1065
+ "line": 34
1066
+ },
1067
+ [
1068
+ "target"
1069
+ ]
1070
+ ],
1071
+ "Elixir.InchTest.Html.Safe.List"
1072
+ ]
1073
+ ],
1074
+ [
1075
+ "::",
1076
+ {
1077
+ "line": 34
1078
+ },
1079
+ [
1080
+ [
1081
+ "__impl__",
1082
+ {
1083
+ "line": 34
1084
+ },
1085
+ [
1086
+ "for"
1087
+ ]
1088
+ ],
1089
+ "Elixir.List"
1090
+ ]
1091
+ ]
1092
+ ],
1093
+ "type": "def"
1094
+ },
1095
+ {
1096
+ "arity": 1,
1097
+ "doc": "Callback implementation of `InchTest.Html.Safe.to_string/1`.",
1098
+ "id": "to_string/1",
1099
+ "module_id": "InchTest.Html.Safe.List",
1100
+ "name": "to_string",
1101
+ "object_type": "FunctionObject",
1102
+ "signature": [
1103
+ [
1104
+ "list",
1105
+ [],
1106
+ null
1107
+ ]
1108
+ ],
1109
+ "source": null,
1110
+ "specs": [],
1111
+ "type": "def"
1112
+ },
1113
+ {
1114
+ "arity": 1,
1115
+ "doc": false,
1116
+ "id": "__impl__/1",
1117
+ "module_id": "InchTest.Html.Safe.Tuple",
1118
+ "name": "__impl__",
1119
+ "object_type": "FunctionObject",
1120
+ "signature": [
1121
+ [
1122
+ "atom1",
1123
+ [],
1124
+ "Elixir"
1125
+ ]
1126
+ ],
1127
+ "source": null,
1128
+ "specs": [
1129
+ [
1130
+ "::",
1131
+ {
1132
+ "line": 72
1133
+ },
1134
+ [
1135
+ [
1136
+ "__impl__",
1137
+ {
1138
+ "line": 72
1139
+ },
1140
+ [
1141
+ "protocol"
1142
+ ]
1143
+ ],
1144
+ "Elixir.InchTest.Html.Safe"
1145
+ ]
1146
+ ],
1147
+ [
1148
+ "::",
1149
+ {
1150
+ "line": 72
1151
+ },
1152
+ [
1153
+ [
1154
+ "__impl__",
1155
+ {
1156
+ "line": 72
1157
+ },
1158
+ [
1159
+ "target"
1160
+ ]
1161
+ ],
1162
+ "Elixir.InchTest.Html.Safe.Tuple"
1163
+ ]
1164
+ ],
1165
+ [
1166
+ "::",
1167
+ {
1168
+ "line": 72
1169
+ },
1170
+ [
1171
+ [
1172
+ "__impl__",
1173
+ {
1174
+ "line": 72
1175
+ },
1176
+ [
1177
+ "for"
1178
+ ]
1179
+ ],
1180
+ "Elixir.Tuple"
1181
+ ]
1182
+ ]
1183
+ ],
1184
+ "type": "def"
1185
+ },
1186
+ {
1187
+ "arity": 1,
1188
+ "doc": "Callback implementation of `InchTest.Html.Safe.to_string/1`.",
1189
+ "id": "to_string/1",
1190
+ "module_id": "InchTest.Html.Safe.Tuple",
1191
+ "name": "to_string",
1192
+ "object_type": "FunctionObject",
1193
+ "signature": [
1194
+ [
1195
+ "arg1",
1196
+ [],
1197
+ "Elixir"
1198
+ ]
1199
+ ],
1200
+ "source": null,
1201
+ "specs": [],
1202
+ "type": "def"
1203
+ },
1204
+ {
1205
+ "arity": 1,
1206
+ "doc": "Converts String to camel case\n\n## Examples\n\n iex> InchTest.Naming.camelize(\"my_app\")\n \"MyApp\"\n\nIn general, `camelize` can be thought of as the reverse of\n`underscore`, however, in some cases formatting may be lost:\n\n InchTest.Naming.underscore \"SAPExample\" #=> \"sap_example\"\n InchTest.Naming.camelize \"sap_example\" #=> \"SapExample\"\n\n",
1207
+ "id": "camelize/1",
1208
+ "module_id": "InchTest.Naming",
1209
+ "name": "camelize",
1210
+ "object_type": "FunctionObject",
1211
+ "signature": [
1212
+ [
1213
+ "arg1",
1214
+ [],
1215
+ "Elixir"
1216
+ ]
1217
+ ],
1218
+ "source": null,
1219
+ "specs": [],
1220
+ "type": "def"
1221
+ },
1222
+ {
1223
+ "arity": 1,
1224
+ "doc": null,
1225
+ "id": "do_camelize/1",
1226
+ "module_id": "InchTest.Naming",
1227
+ "name": "do_camelize",
1228
+ "object_type": "FunctionObject",
1229
+ "signature": [
1230
+ [
1231
+ "arg1",
1232
+ [],
1233
+ "Elixir"
1234
+ ]
1235
+ ],
1236
+ "source": null,
1237
+ "specs": [],
1238
+ "type": "def"
1239
+ },
1240
+ {
1241
+ "arity": 2,
1242
+ "doc": null,
1243
+ "id": "do_underscore/2",
1244
+ "module_id": "InchTest.Naming",
1245
+ "name": "do_underscore",
1246
+ "object_type": "FunctionObject",
1247
+ "signature": [
1248
+ [
1249
+ "arg1",
1250
+ [],
1251
+ "Elixir"
1252
+ ],
1253
+ [
1254
+ "prev",
1255
+ [],
1256
+ null
1257
+ ]
1258
+ ],
1259
+ "source": null,
1260
+ "specs": [],
1261
+ "type": "def"
1262
+ },
1263
+ {
1264
+ "arity": 2,
1265
+ "doc": null,
1266
+ "id": "remove_suffix/2",
1267
+ "module_id": "InchTest.Naming",
1268
+ "name": "remove_suffix",
1269
+ "object_type": "FunctionObject",
1270
+ "signature": [
1271
+ [
1272
+ "alias",
1273
+ [],
1274
+ null
1275
+ ],
1276
+ [
1277
+ "suffix",
1278
+ [],
1279
+ null
1280
+ ]
1281
+ ],
1282
+ "source": null,
1283
+ "specs": [],
1284
+ "type": "def"
1285
+ },
1286
+ {
1287
+ "arity": 2,
1288
+ "doc": "Extracts the resource name from an alias\n\n## Examples\n\n iex> InchTest.Naming.resource_name(MyApp.User)\n \"user\"\n iex> InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n \"user\"\n\n",
1289
+ "id": "resource_name/2",
1290
+ "module_id": "InchTest.Naming",
1291
+ "name": "resource_name",
1292
+ "object_type": "FunctionObject",
1293
+ "signature": [
1294
+ [
1295
+ "alias",
1296
+ [],
1297
+ null
1298
+ ],
1299
+ [
1300
+ "\\\\",
1301
+ [],
1302
+ [
1303
+ [
1304
+ "suffix",
1305
+ [],
1306
+ null
1307
+ ],
1308
+ null
1309
+ ]
1310
+ ]
1311
+ ],
1312
+ "source": null,
1313
+ "specs": [],
1314
+ "type": "def"
1315
+ },
1316
+ {
1317
+ "arity": 1,
1318
+ "doc": null,
1319
+ "id": "to_lower_char/1",
1320
+ "module_id": "InchTest.Naming",
1321
+ "name": "to_lower_char",
1322
+ "object_type": "FunctionObject",
1323
+ "signature": [
1324
+ [
1325
+ "char",
1326
+ [],
1327
+ null
1328
+ ]
1329
+ ],
1330
+ "source": null,
1331
+ "specs": [],
1332
+ "type": "def"
1333
+ },
1334
+ {
1335
+ "arity": 1,
1336
+ "doc": null,
1337
+ "id": "to_upper_char/1",
1338
+ "module_id": "InchTest.Naming",
1339
+ "name": "to_upper_char",
1340
+ "object_type": "FunctionObject",
1341
+ "signature": [
1342
+ [
1343
+ "char",
1344
+ [],
1345
+ null
1346
+ ]
1347
+ ],
1348
+ "source": null,
1349
+ "specs": [],
1350
+ "type": "def"
1351
+ },
1352
+ {
1353
+ "arity": 1,
1354
+ "doc": "Converts String to underscore case\n\n## Examples\n\n iex> InchTest.Naming.underscore(\"MyApp\")\n \"my_app\"\n\n iex> InchTest.Naming.underscore(\"my-app\")\n \"my_app\"\n\nIn general, `underscore` can be thought of as the reverse of\n`camelize`, however, in some cases formatting may be lost:\n\n Naming.underscore \"SAPExample\" #=> \"sap_example\"\n Naming.camelize \"sap_example\" #=> \"SapExample\"\n\n",
1355
+ "id": "underscore/1",
1356
+ "module_id": "InchTest.Naming",
1357
+ "name": "underscore",
1358
+ "object_type": "FunctionObject",
1359
+ "signature": [
1360
+ [
1361
+ "arg1",
1362
+ [],
1363
+ "Elixir"
1364
+ ]
1365
+ ],
1366
+ "source": null,
1367
+ "specs": [],
1368
+ "type": "def"
1369
+ }
1370
+ ],
1371
+ "travis": true,
1372
+ "travis_branch": "master",
1373
+ "travis_commit": null,
1374
+ "travis_job_id": null,
1375
+ "travis_repo_slug": "rrrene/inch_ex"
609
1376
  }
data/test/unit/language/elixir/code_object/module_object_test.rb CHANGED
@@ -15,4 +15,29 @@ describe ::Inch::Language::Elixir::CodeObject::ModuleObject do
15
15
  assert m.score >= 50
16
16
  end
17
17
  end
18
+
19
+ it 'should recognize moduledoc' do
20
+ m = @objects.find('InchTest.Invisible')
21
+ # defined in Hello-World-Elixir, but not in report since
22
+ # `@moduledoc false` excludes it
23
+ assert m.nil?
24
+ end
25
+
26
+ it 'should recognize moduledoc' do
27
+ m = @objects.find('InchTest.Invisible.foo')
28
+ # defined in Hello-World-Elixir, but not in report since
29
+ # `@moduledoc false` excludes it
30
+ assert m.nil?
31
+ end
32
+
33
+ it 'should recognize protocols' do
34
+ m = @objects.find('InchTest.Html.Safe')
35
+ refute m.nodoc?
36
+ end
37
+
38
+ it 'should recognize implementations' do
39
+ m = @objects.find('InchTest.Html.Safe.Atom')
40
+ assert m.nodoc?
41
+ assert m.priority < 0
42
+ end
18
43
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: inch
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.2
4
+ version: 0.5.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - René Föhring
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-10-08 00:00:00.000000000 Z
11
+ date: 2014-10-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler